/* * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ /* * Do not modify this file. This file is generated from the s3-2006-03-01.normal.json service model. */ using System; using System.Collections.Generic; using Amazon.Runtime; using Amazon.S3.Model; namespace Amazon.S3 { /// <summary> /// Interface for accessing S3 /// /// /// </summary> public partial interface IAmazonS3 : IAmazonService, IDisposable { #if BCL45 || AWS_ASYNC_ENUMERABLES_API /// <summary> /// Paginators for the service /// </summary> IS3PaginatorFactory Paginators { get; } #endif #region AbortMultipartUpload /// <summary> /// 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. /// /// /// <para> /// To verify that all parts have been removed, so you don't get charged for the part /// storage, you should call the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html">ListParts</a> /// action and ensure that the parts list is empty. /// </para> /// /// <para> /// For information about permissions required to use the multipart upload, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html">Multipart /// Upload and Permissions</a>. /// </para> /// /// <para> /// The following operations are related to <code>AbortMultipartUpload</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html">CreateMultipartUpload</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html">UploadPart</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html">CompleteMultipartUpload</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html">ListParts</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html">ListMultipartUploads</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="bucketName">The bucket name to which the upload was taking place. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>. When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</param> /// <param name="key">Key of the object for which the multipart upload was initiated.</param> /// <param name="uploadId">Upload ID that identifies the multipart upload.</param> /// /// <returns>The response from the AbortMultipartUpload service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/AbortMultipartUpload">REST API Reference for AbortMultipartUpload Operation</seealso> AbortMultipartUploadResponse AbortMultipartUpload(string bucketName, string key, string uploadId); /// <summary> /// 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. /// /// /// <para> /// To verify that all parts have been removed, so you don't get charged for the part /// storage, you should call the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html">ListParts</a> /// action and ensure that the parts list is empty. /// </para> /// /// <para> /// For information about permissions required to use the multipart upload, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html">Multipart /// Upload and Permissions</a>. /// </para> /// /// <para> /// The following operations are related to <code>AbortMultipartUpload</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html">CreateMultipartUpload</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html">UploadPart</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html">CompleteMultipartUpload</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html">ListParts</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html">ListMultipartUploads</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the AbortMultipartUpload service method.</param> /// /// <returns>The response from the AbortMultipartUpload service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/AbortMultipartUpload">REST API Reference for AbortMultipartUpload Operation</seealso> AbortMultipartUploadResponse AbortMultipartUpload(AbortMultipartUploadRequest request); /// <summary> /// Initiates the asynchronous execution of the AbortMultipartUpload operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the AbortMultipartUpload operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndAbortMultipartUpload /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/AbortMultipartUpload">REST API Reference for AbortMultipartUpload Operation</seealso> IAsyncResult BeginAbortMultipartUpload(AbortMultipartUploadRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the AbortMultipartUpload operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginAbortMultipartUpload.</param> /// /// <returns>Returns a AbortMultipartUploadResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/AbortMultipartUpload">REST API Reference for AbortMultipartUpload Operation</seealso> AbortMultipartUploadResponse EndAbortMultipartUpload(IAsyncResult asyncResult); #endregion #region CompleteMultipartUpload /// <summary> /// Completes a multipart upload by assembling previously uploaded parts. /// /// /// <para> /// You first initiate the multipart upload and then upload all parts using the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html">UploadPart</a> /// 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 <code>ETag</code> /// value, returned after that part was uploaded. /// </para> /// /// <para> /// 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. A request could /// fail after the initial 200 OK response has been sent. This means that a <code>200 /// OK</code> response can contain either a success or an error. If you call the S3 API /// directly, make sure to design your application to parse the contents of the response /// and handle it appropriately. If you use Amazon Web Services SDKs, SDKs handle this /// condition. The SDKs detect the embedded error and apply error handling per your configuration /// settings (including automatically retrying the request as appropriate). If the condition /// persists, the SDKs throws an exception (or, for the SDKs that don't use exceptions, /// they return the error). /// </para> /// /// <para> /// Note that if <code>CompleteMultipartUpload</code> fails, applications should be prepared /// to retry the failed requests. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ErrorBestPractices.html">Amazon /// S3 Error Best Practices</a>. /// </para> /// <important> /// <para> /// You cannot use <code>Content-Type: application/x-www-form-urlencoded</code> with Complete /// Multipart Upload requests. Also, if you do not provide a <code>Content-Type</code> /// header, <code>CompleteMultipartUpload</code> returns a 200 OK response. /// </para> /// </important> /// <para> /// For more information about multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html">Uploading /// Objects Using Multipart Upload</a>. /// </para> /// /// <para> /// For information about permissions required to use the multipart upload API, see <a /// href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html">Multipart /// Upload and Permissions</a>. /// </para> /// /// <para> /// <code>CompleteMultipartUpload</code> has the following special errors: /// </para> /// <ul> <li> /// <para> /// Error code: <code>EntityTooSmall</code> /// </para> /// <ul> <li> /// <para> /// 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. /// </para> /// </li> <li> /// <para> /// 400 Bad Request /// </para> /// </li> </ul> </li> <li> /// <para> /// Error code: <code>InvalidPart</code> /// </para> /// <ul> <li> /// <para> /// 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. /// </para> /// </li> <li> /// <para> /// 400 Bad Request /// </para> /// </li> </ul> </li> <li> /// <para> /// Error code: <code>InvalidPartOrder</code> /// </para> /// <ul> <li> /// <para> /// Description: The list of parts was not in ascending order. The parts list must be /// specified in order by part number. /// </para> /// </li> <li> /// <para> /// 400 Bad Request /// </para> /// </li> </ul> </li> <li> /// <para> /// Error code: <code>NoSuchUpload</code> /// </para> /// <ul> <li> /// <para> /// Description: The specified multipart upload does not exist. The upload ID might be /// invalid, or the multipart upload might have been aborted or completed. /// </para> /// </li> <li> /// <para> /// 404 Not Found /// </para> /// </li> </ul> </li> </ul> /// <para> /// The following operations are related to <code>CompleteMultipartUpload</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html">CreateMultipartUpload</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html">UploadPart</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html">AbortMultipartUpload</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html">ListParts</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html">ListMultipartUploads</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the CompleteMultipartUpload service method.</param> /// /// <returns>The response from the CompleteMultipartUpload service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/CompleteMultipartUpload">REST API Reference for CompleteMultipartUpload Operation</seealso> CompleteMultipartUploadResponse CompleteMultipartUpload(CompleteMultipartUploadRequest request); /// <summary> /// Initiates the asynchronous execution of the CompleteMultipartUpload operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the CompleteMultipartUpload operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCompleteMultipartUpload /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/CompleteMultipartUpload">REST API Reference for CompleteMultipartUpload Operation</seealso> IAsyncResult BeginCompleteMultipartUpload(CompleteMultipartUploadRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the CompleteMultipartUpload operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginCompleteMultipartUpload.</param> /// /// <returns>Returns a CompleteMultipartUploadResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/CompleteMultipartUpload">REST API Reference for CompleteMultipartUpload Operation</seealso> CompleteMultipartUploadResponse EndCompleteMultipartUpload(IAsyncResult asyncResult); #endregion #region CopyObject /// <summary> /// Creates a copy of an object that is already stored in Amazon S3. /// /// <note> /// <para> /// 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/CopyingObjctsUsingRESTMPUapi.html">Copy /// Object Using the REST Multipart Upload API</a>. /// </para> /// </note> /// <para> /// All copy requests must be authenticated. Additionally, you must have <i>read</i> access /// to the source object and <i>write</i> access to the destination bucket. For more information, /// see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html">REST /// Authentication</a>. 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. /// </para> /// /// <para> /// 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 <code>200 OK</code> response. This means that /// a <code>200 OK</code> response can contain either a success or an error. If you call /// the S3 API directly, make sure to design your application to parse the contents of /// the response and handle it appropriately. If you use Amazon Web Services SDKs, SDKs /// handle this condition. The SDKs detect the embedded error and apply error handling /// per your configuration settings (including automatically retrying the request as appropriate). /// If the condition persists, the SDKs throws an exception (or, for the SDKs that don't /// use exceptions, they return the error). /// </para> /// /// <para> /// If the copy is successful, you receive a response with information about the copied /// object. /// </para> /// <note> /// <para> /// 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. /// </para> /// </note> /// <para> /// The copy request charge is based on the storage class and Region that you specify /// for the destination object. The request can also result in a data retrieval charge /// for the source if the source storage class bills for data retrieval. For pricing information, /// see <a href="http://aws.amazon.com/s3/pricing/">Amazon S3 pricing</a>. /// </para> /// <important> /// <para> /// 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 <code>Bad /// Request</code> error. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html">Transfer /// Acceleration</a>. /// </para> /// </important> <dl> <dt>Metadata</dt> <dd> /// <para> /// When copying an object, you can preserve all metadata (the default) or specify new /// metadata. However, the access control list (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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html">Using /// ACLs</a>. /// </para> /// /// <para> /// 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 <code>x-amz-metadata-directive</code> /// header. When you grant permissions, you can use the <code>s3:x-amz-metadata-directive</code> /// condition key to enforce certain metadata behavior when objects are uploaded. For /// more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/amazon-s3-policy-keys.html">Specifying /// Conditions in a Policy</a> in the <i>Amazon S3 User Guide</i>. For a complete list /// of Amazon S3-specific condition keys, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/list_amazons3.html">Actions, /// Resources, and Condition Keys for Amazon S3</a>. /// </para> /// <note> /// <para> /// <code>x-amz-website-redirect-location</code> is unique to each object and must be /// specified in the request headers to copy the value. /// </para> /// </note> </dd> <dt>x-amz-copy-source-if Headers</dt> <dd> /// <para> /// To only copy an object under certain conditions, such as whether the <code>Etag</code> /// matches or whether the object was modified before or after a specified date, use the /// following request parameters: /// </para> /// <ul> <li> /// <para> /// <code>x-amz-copy-source-if-match</code> /// </para> /// </li> <li> /// <para> /// <code>x-amz-copy-source-if-none-match</code> /// </para> /// </li> <li> /// <para> /// <code>x-amz-copy-source-if-unmodified-since</code> /// </para> /// </li> <li> /// <para> /// <code>x-amz-copy-source-if-modified-since</code> /// </para> /// </li> </ul> /// <para> /// If both the <code>x-amz-copy-source-if-match</code> and <code>x-amz-copy-source-if-unmodified-since</code> /// headers are present in the request and evaluate as follows, Amazon S3 returns <code>200 /// OK</code> and copies the data: /// </para> /// <ul> <li> /// <para> /// <code>x-amz-copy-source-if-match</code> condition evaluates to true /// </para> /// </li> <li> /// <para> /// <code>x-amz-copy-source-if-unmodified-since</code> condition evaluates to false /// </para> /// </li> </ul> /// <para> /// If both the <code>x-amz-copy-source-if-none-match</code> and <code>x-amz-copy-source-if-modified-since</code> /// headers are present in the request and evaluate as follows, Amazon S3 returns the /// <code>412 Precondition Failed</code> response code: /// </para> /// <ul> <li> /// <para> /// <code>x-amz-copy-source-if-none-match</code> condition evaluates to false /// </para> /// </li> <li> /// <para> /// <code>x-amz-copy-source-if-modified-since</code> condition evaluates to true /// </para> /// </li> </ul> <note> /// <para> /// All headers with the <code>x-amz-</code> prefix, including <code>x-amz-copy-source</code>, /// must be signed. /// </para> /// </note> </dd> <dt>Server-side encryption</dt> <dd> /// <para> /// Amazon S3 automatically encrypts all new objects that are copied to an S3 bucket. /// When copying an object, if you don't specify encryption information in your copy request, /// the encryption setting of the target object is set to the default encryption configuration /// of the destination bucket. By default, all buckets have a base level of encryption /// configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3). /// If the destination bucket has a default encryption configuration that uses server-side /// encryption with Key Management Service (KMS) keys (SSE-KMS), dual-layer server-side /// encryption with Amazon Web Services KMS keys (DSSE-KMS), or server-side encryption /// with customer-provided encryption keys (SSE-C), Amazon S3 uses the corresponding KMS /// key, or a customer-provided key to encrypt the target object copy. /// </para> /// /// <para> /// When you perform a <code>CopyObject</code> operation, if you want to use a different /// type of encryption setting for the target object, you can use other appropriate encryption-related /// headers to encrypt the target object with a KMS key, an Amazon S3 managed key, or /// a customer-provided key. With server-side encryption, Amazon S3 encrypts your data /// as it writes your data to disks in its data centers and decrypts the data when you /// access it. If the encryption setting in your request is different from the default /// encryption configuration of the destination bucket, the encryption setting in your /// request takes precedence. If the source object for the copy is stored in Amazon S3 /// using SSE-C, you must provide the necessary encryption information in your request /// so that Amazon S3 can decrypt the object for copying. For more information about server-side /// encryption, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html">Using /// Server-Side Encryption</a>. /// </para> /// /// <para> /// If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object. For /// more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html">Amazon /// S3 Bucket Keys</a> in the <i>Amazon S3 User Guide</i>. /// </para> /// </dd> <dt>Access Control List (ACL)-Specific Request Headers</dt> <dd> /// <para> /// 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 that are defined by Amazon S3. These permissions are then /// added to the ACL on the object. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html">Access /// Control List (ACL) Overview</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-using-rest-api.html">Managing /// ACLs Using the REST API</a>. /// </para> /// /// <para> /// 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 <code>PUT</code> requests that don't specify an /// ACL or <code>PUT</code> requests that specify bucket owner full control ACLs, such /// as the <code>bucket-owner-full-control</code> canned ACL or an equivalent form of /// this ACL expressed in the XML format. /// </para> /// /// <para> /// For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html"> /// Controlling ownership of objects and disabling ACLs</a> in the <i>Amazon S3 User Guide</i>. /// </para> /// <note> /// <para> /// 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. /// </para> /// </note> </dd> <dt>Checksums</dt> <dd> /// <para> /// 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 can optionally specify a /// different checksum algorithm to use with the <code>x-amz-checksum-algorithm</code> /// header. /// </para> /// </dd> <dt>Storage Class Options</dt> <dd> /// <para> /// You can use the <code>CopyObject</code> action to change the storage class of an object /// that is already stored in Amazon S3 by using the <code>StorageClass</code> parameter. /// For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html">Storage /// Classes</a> in the <i>Amazon S3 User Guide</i>. /// </para> /// /// <para> /// 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html">RestoreObject</a>. /// For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/CopyingObjectsExamples.html">Copying /// Objects</a>. /// </para> /// </dd> <dt>Versioning</dt> <dd> /// <para> /// By default, <code>x-amz-copy-source</code> header 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 <code>versionId</code> /// subresource. /// </para> /// /// <para> /// 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 <code>x-amz-version-id</code> /// response header in the response. /// </para> /// /// <para> /// If you do not enable versioning or suspend it on the target bucket, the version ID /// that Amazon S3 generates is always null. /// </para> /// </dd> </dl> /// <para> /// The following operations are related to <code>CopyObject</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html">PutObject</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="sourceBucket">A property of CopyObjectRequest used to execute the CopyObject service method.</param> /// <param name="sourceKey">A property of CopyObjectRequest used to execute the CopyObject service method.</param> /// <param name="destinationBucket">The name of the destination bucket. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>. When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</param> /// <param name="destinationKey">A property of CopyObjectRequest used to execute the CopyObject service method.</param> /// /// <returns>The response from the CopyObject service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/CopyObject">REST API Reference for CopyObject Operation</seealso> CopyObjectResponse CopyObject(string sourceBucket, string sourceKey, string destinationBucket, string destinationKey); /// <summary> /// Creates a copy of an object that is already stored in Amazon S3. /// /// <note> /// <para> /// 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/CopyingObjctsUsingRESTMPUapi.html">Copy /// Object Using the REST Multipart Upload API</a>. /// </para> /// </note> /// <para> /// All copy requests must be authenticated. Additionally, you must have <i>read</i> access /// to the source object and <i>write</i> access to the destination bucket. For more information, /// see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html">REST /// Authentication</a>. 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. /// </para> /// /// <para> /// 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 <code>200 OK</code> response. This means that /// a <code>200 OK</code> response can contain either a success or an error. If you call /// the S3 API directly, make sure to design your application to parse the contents of /// the response and handle it appropriately. If you use Amazon Web Services SDKs, SDKs /// handle this condition. The SDKs detect the embedded error and apply error handling /// per your configuration settings (including automatically retrying the request as appropriate). /// If the condition persists, the SDKs throws an exception (or, for the SDKs that don't /// use exceptions, they return the error). /// </para> /// /// <para> /// If the copy is successful, you receive a response with information about the copied /// object. /// </para> /// <note> /// <para> /// 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. /// </para> /// </note> /// <para> /// The copy request charge is based on the storage class and Region that you specify /// for the destination object. The request can also result in a data retrieval charge /// for the source if the source storage class bills for data retrieval. For pricing information, /// see <a href="http://aws.amazon.com/s3/pricing/">Amazon S3 pricing</a>. /// </para> /// <important> /// <para> /// 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 <code>Bad /// Request</code> error. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html">Transfer /// Acceleration</a>. /// </para> /// </important> <dl> <dt>Metadata</dt> <dd> /// <para> /// When copying an object, you can preserve all metadata (the default) or specify new /// metadata. However, the access control list (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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html">Using /// ACLs</a>. /// </para> /// /// <para> /// 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 <code>x-amz-metadata-directive</code> /// header. When you grant permissions, you can use the <code>s3:x-amz-metadata-directive</code> /// condition key to enforce certain metadata behavior when objects are uploaded. For /// more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/amazon-s3-policy-keys.html">Specifying /// Conditions in a Policy</a> in the <i>Amazon S3 User Guide</i>. For a complete list /// of Amazon S3-specific condition keys, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/list_amazons3.html">Actions, /// Resources, and Condition Keys for Amazon S3</a>. /// </para> /// <note> /// <para> /// <code>x-amz-website-redirect-location</code> is unique to each object and must be /// specified in the request headers to copy the value. /// </para> /// </note> </dd> <dt>x-amz-copy-source-if Headers</dt> <dd> /// <para> /// To only copy an object under certain conditions, such as whether the <code>Etag</code> /// matches or whether the object was modified before or after a specified date, use the /// following request parameters: /// </para> /// <ul> <li> /// <para> /// <code>x-amz-copy-source-if-match</code> /// </para> /// </li> <li> /// <para> /// <code>x-amz-copy-source-if-none-match</code> /// </para> /// </li> <li> /// <para> /// <code>x-amz-copy-source-if-unmodified-since</code> /// </para> /// </li> <li> /// <para> /// <code>x-amz-copy-source-if-modified-since</code> /// </para> /// </li> </ul> /// <para> /// If both the <code>x-amz-copy-source-if-match</code> and <code>x-amz-copy-source-if-unmodified-since</code> /// headers are present in the request and evaluate as follows, Amazon S3 returns <code>200 /// OK</code> and copies the data: /// </para> /// <ul> <li> /// <para> /// <code>x-amz-copy-source-if-match</code> condition evaluates to true /// </para> /// </li> <li> /// <para> /// <code>x-amz-copy-source-if-unmodified-since</code> condition evaluates to false /// </para> /// </li> </ul> /// <para> /// If both the <code>x-amz-copy-source-if-none-match</code> and <code>x-amz-copy-source-if-modified-since</code> /// headers are present in the request and evaluate as follows, Amazon S3 returns the /// <code>412 Precondition Failed</code> response code: /// </para> /// <ul> <li> /// <para> /// <code>x-amz-copy-source-if-none-match</code> condition evaluates to false /// </para> /// </li> <li> /// <para> /// <code>x-amz-copy-source-if-modified-since</code> condition evaluates to true /// </para> /// </li> </ul> <note> /// <para> /// All headers with the <code>x-amz-</code> prefix, including <code>x-amz-copy-source</code>, /// must be signed. /// </para> /// </note> </dd> <dt>Server-side encryption</dt> <dd> /// <para> /// Amazon S3 automatically encrypts all new objects that are copied to an S3 bucket. /// When copying an object, if you don't specify encryption information in your copy request, /// the encryption setting of the target object is set to the default encryption configuration /// of the destination bucket. By default, all buckets have a base level of encryption /// configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3). /// If the destination bucket has a default encryption configuration that uses server-side /// encryption with Key Management Service (KMS) keys (SSE-KMS), dual-layer server-side /// encryption with Amazon Web Services KMS keys (DSSE-KMS), or server-side encryption /// with customer-provided encryption keys (SSE-C), Amazon S3 uses the corresponding KMS /// key, or a customer-provided key to encrypt the target object copy. /// </para> /// /// <para> /// When you perform a <code>CopyObject</code> operation, if you want to use a different /// type of encryption setting for the target object, you can use other appropriate encryption-related /// headers to encrypt the target object with a KMS key, an Amazon S3 managed key, or /// a customer-provided key. With server-side encryption, Amazon S3 encrypts your data /// as it writes your data to disks in its data centers and decrypts the data when you /// access it. If the encryption setting in your request is different from the default /// encryption configuration of the destination bucket, the encryption setting in your /// request takes precedence. If the source object for the copy is stored in Amazon S3 /// using SSE-C, you must provide the necessary encryption information in your request /// so that Amazon S3 can decrypt the object for copying. For more information about server-side /// encryption, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html">Using /// Server-Side Encryption</a>. /// </para> /// /// <para> /// If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object. For /// more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html">Amazon /// S3 Bucket Keys</a> in the <i>Amazon S3 User Guide</i>. /// </para> /// </dd> <dt>Access Control List (ACL)-Specific Request Headers</dt> <dd> /// <para> /// 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 that are defined by Amazon S3. These permissions are then /// added to the ACL on the object. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html">Access /// Control List (ACL) Overview</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-using-rest-api.html">Managing /// ACLs Using the REST API</a>. /// </para> /// /// <para> /// 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 <code>PUT</code> requests that don't specify an /// ACL or <code>PUT</code> requests that specify bucket owner full control ACLs, such /// as the <code>bucket-owner-full-control</code> canned ACL or an equivalent form of /// this ACL expressed in the XML format. /// </para> /// /// <para> /// For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html"> /// Controlling ownership of objects and disabling ACLs</a> in the <i>Amazon S3 User Guide</i>. /// </para> /// <note> /// <para> /// 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. /// </para> /// </note> </dd> <dt>Checksums</dt> <dd> /// <para> /// 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 can optionally specify a /// different checksum algorithm to use with the <code>x-amz-checksum-algorithm</code> /// header. /// </para> /// </dd> <dt>Storage Class Options</dt> <dd> /// <para> /// You can use the <code>CopyObject</code> action to change the storage class of an object /// that is already stored in Amazon S3 by using the <code>StorageClass</code> parameter. /// For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html">Storage /// Classes</a> in the <i>Amazon S3 User Guide</i>. /// </para> /// /// <para> /// 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html">RestoreObject</a>. /// For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/CopyingObjectsExamples.html">Copying /// Objects</a>. /// </para> /// </dd> <dt>Versioning</dt> <dd> /// <para> /// By default, <code>x-amz-copy-source</code> header 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 <code>versionId</code> /// subresource. /// </para> /// /// <para> /// 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 <code>x-amz-version-id</code> /// response header in the response. /// </para> /// /// <para> /// If you do not enable versioning or suspend it on the target bucket, the version ID /// that Amazon S3 generates is always null. /// </para> /// </dd> </dl> /// <para> /// The following operations are related to <code>CopyObject</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html">PutObject</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="sourceBucket">A property of CopyObjectRequest used to execute the CopyObject service method.</param> /// <param name="sourceKey">A property of CopyObjectRequest used to execute the CopyObject service method.</param> /// <param name="sourceVersionId">A property of CopyObjectRequest used to execute the CopyObject service method.</param> /// <param name="destinationBucket">The name of the destination bucket. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>. When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</param> /// <param name="destinationKey">A property of CopyObjectRequest used to execute the CopyObject service method.</param> /// /// <returns>The response from the CopyObject service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/CopyObject">REST API Reference for CopyObject Operation</seealso> CopyObjectResponse CopyObject(string sourceBucket, string sourceKey, string sourceVersionId, string destinationBucket, string destinationKey); /// <summary> /// Creates a copy of an object that is already stored in Amazon S3. /// /// <note> /// <para> /// 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/CopyingObjctsUsingRESTMPUapi.html">Copy /// Object Using the REST Multipart Upload API</a>. /// </para> /// </note> /// <para> /// All copy requests must be authenticated. Additionally, you must have <i>read</i> access /// to the source object and <i>write</i> access to the destination bucket. For more information, /// see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html">REST /// Authentication</a>. 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. /// </para> /// /// <para> /// 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 <code>200 OK</code> response. This means that /// a <code>200 OK</code> response can contain either a success or an error. If you call /// the S3 API directly, make sure to design your application to parse the contents of /// the response and handle it appropriately. If you use Amazon Web Services SDKs, SDKs /// handle this condition. The SDKs detect the embedded error and apply error handling /// per your configuration settings (including automatically retrying the request as appropriate). /// If the condition persists, the SDKs throws an exception (or, for the SDKs that don't /// use exceptions, they return the error). /// </para> /// /// <para> /// If the copy is successful, you receive a response with information about the copied /// object. /// </para> /// <note> /// <para> /// 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. /// </para> /// </note> /// <para> /// The copy request charge is based on the storage class and Region that you specify /// for the destination object. The request can also result in a data retrieval charge /// for the source if the source storage class bills for data retrieval. For pricing information, /// see <a href="http://aws.amazon.com/s3/pricing/">Amazon S3 pricing</a>. /// </para> /// <important> /// <para> /// 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 <code>Bad /// Request</code> error. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html">Transfer /// Acceleration</a>. /// </para> /// </important> <dl> <dt>Metadata</dt> <dd> /// <para> /// When copying an object, you can preserve all metadata (the default) or specify new /// metadata. However, the access control list (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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html">Using /// ACLs</a>. /// </para> /// /// <para> /// 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 <code>x-amz-metadata-directive</code> /// header. When you grant permissions, you can use the <code>s3:x-amz-metadata-directive</code> /// condition key to enforce certain metadata behavior when objects are uploaded. For /// more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/amazon-s3-policy-keys.html">Specifying /// Conditions in a Policy</a> in the <i>Amazon S3 User Guide</i>. For a complete list /// of Amazon S3-specific condition keys, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/list_amazons3.html">Actions, /// Resources, and Condition Keys for Amazon S3</a>. /// </para> /// <note> /// <para> /// <code>x-amz-website-redirect-location</code> is unique to each object and must be /// specified in the request headers to copy the value. /// </para> /// </note> </dd> <dt>x-amz-copy-source-if Headers</dt> <dd> /// <para> /// To only copy an object under certain conditions, such as whether the <code>Etag</code> /// matches or whether the object was modified before or after a specified date, use the /// following request parameters: /// </para> /// <ul> <li> /// <para> /// <code>x-amz-copy-source-if-match</code> /// </para> /// </li> <li> /// <para> /// <code>x-amz-copy-source-if-none-match</code> /// </para> /// </li> <li> /// <para> /// <code>x-amz-copy-source-if-unmodified-since</code> /// </para> /// </li> <li> /// <para> /// <code>x-amz-copy-source-if-modified-since</code> /// </para> /// </li> </ul> /// <para> /// If both the <code>x-amz-copy-source-if-match</code> and <code>x-amz-copy-source-if-unmodified-since</code> /// headers are present in the request and evaluate as follows, Amazon S3 returns <code>200 /// OK</code> and copies the data: /// </para> /// <ul> <li> /// <para> /// <code>x-amz-copy-source-if-match</code> condition evaluates to true /// </para> /// </li> <li> /// <para> /// <code>x-amz-copy-source-if-unmodified-since</code> condition evaluates to false /// </para> /// </li> </ul> /// <para> /// If both the <code>x-amz-copy-source-if-none-match</code> and <code>x-amz-copy-source-if-modified-since</code> /// headers are present in the request and evaluate as follows, Amazon S3 returns the /// <code>412 Precondition Failed</code> response code: /// </para> /// <ul> <li> /// <para> /// <code>x-amz-copy-source-if-none-match</code> condition evaluates to false /// </para> /// </li> <li> /// <para> /// <code>x-amz-copy-source-if-modified-since</code> condition evaluates to true /// </para> /// </li> </ul> <note> /// <para> /// All headers with the <code>x-amz-</code> prefix, including <code>x-amz-copy-source</code>, /// must be signed. /// </para> /// </note> </dd> <dt>Server-side encryption</dt> <dd> /// <para> /// Amazon S3 automatically encrypts all new objects that are copied to an S3 bucket. /// When copying an object, if you don't specify encryption information in your copy request, /// the encryption setting of the target object is set to the default encryption configuration /// of the destination bucket. By default, all buckets have a base level of encryption /// configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3). /// If the destination bucket has a default encryption configuration that uses server-side /// encryption with Key Management Service (KMS) keys (SSE-KMS), dual-layer server-side /// encryption with Amazon Web Services KMS keys (DSSE-KMS), or server-side encryption /// with customer-provided encryption keys (SSE-C), Amazon S3 uses the corresponding KMS /// key, or a customer-provided key to encrypt the target object copy. /// </para> /// /// <para> /// When you perform a <code>CopyObject</code> operation, if you want to use a different /// type of encryption setting for the target object, you can use other appropriate encryption-related /// headers to encrypt the target object with a KMS key, an Amazon S3 managed key, or /// a customer-provided key. With server-side encryption, Amazon S3 encrypts your data /// as it writes your data to disks in its data centers and decrypts the data when you /// access it. If the encryption setting in your request is different from the default /// encryption configuration of the destination bucket, the encryption setting in your /// request takes precedence. If the source object for the copy is stored in Amazon S3 /// using SSE-C, you must provide the necessary encryption information in your request /// so that Amazon S3 can decrypt the object for copying. For more information about server-side /// encryption, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html">Using /// Server-Side Encryption</a>. /// </para> /// /// <para> /// If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object. For /// more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html">Amazon /// S3 Bucket Keys</a> in the <i>Amazon S3 User Guide</i>. /// </para> /// </dd> <dt>Access Control List (ACL)-Specific Request Headers</dt> <dd> /// <para> /// 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 that are defined by Amazon S3. These permissions are then /// added to the ACL on the object. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html">Access /// Control List (ACL) Overview</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-using-rest-api.html">Managing /// ACLs Using the REST API</a>. /// </para> /// /// <para> /// 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 <code>PUT</code> requests that don't specify an /// ACL or <code>PUT</code> requests that specify bucket owner full control ACLs, such /// as the <code>bucket-owner-full-control</code> canned ACL or an equivalent form of /// this ACL expressed in the XML format. /// </para> /// /// <para> /// For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html"> /// Controlling ownership of objects and disabling ACLs</a> in the <i>Amazon S3 User Guide</i>. /// </para> /// <note> /// <para> /// 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. /// </para> /// </note> </dd> <dt>Checksums</dt> <dd> /// <para> /// 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 can optionally specify a /// different checksum algorithm to use with the <code>x-amz-checksum-algorithm</code> /// header. /// </para> /// </dd> <dt>Storage Class Options</dt> <dd> /// <para> /// You can use the <code>CopyObject</code> action to change the storage class of an object /// that is already stored in Amazon S3 by using the <code>StorageClass</code> parameter. /// For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html">Storage /// Classes</a> in the <i>Amazon S3 User Guide</i>. /// </para> /// /// <para> /// 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html">RestoreObject</a>. /// For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/CopyingObjectsExamples.html">Copying /// Objects</a>. /// </para> /// </dd> <dt>Versioning</dt> <dd> /// <para> /// By default, <code>x-amz-copy-source</code> header 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 <code>versionId</code> /// subresource. /// </para> /// /// <para> /// 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 <code>x-amz-version-id</code> /// response header in the response. /// </para> /// /// <para> /// If you do not enable versioning or suspend it on the target bucket, the version ID /// that Amazon S3 generates is always null. /// </para> /// </dd> </dl> /// <para> /// The following operations are related to <code>CopyObject</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html">PutObject</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the CopyObject service method.</param> /// /// <returns>The response from the CopyObject service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/CopyObject">REST API Reference for CopyObject Operation</seealso> CopyObjectResponse CopyObject(CopyObjectRequest request); /// <summary> /// Initiates the asynchronous execution of the CopyObject operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the CopyObject operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCopyObject /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/CopyObject">REST API Reference for CopyObject Operation</seealso> IAsyncResult BeginCopyObject(CopyObjectRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the CopyObject operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginCopyObject.</param> /// /// <returns>Returns a CopyObjectResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/CopyObject">REST API Reference for CopyObject Operation</seealso> CopyObjectResponse EndCopyObject(IAsyncResult asyncResult); #endregion #region CopyPart /// <summary> /// Uploads a part by copying data from an existing object as data source. You specify /// the data source by adding the request header <code>x-amz-copy-source</code> in your /// request and a byte range by adding the request header <code>x-amz-copy-source-range</code> /// in your request. /// /// /// <para> /// For information about maximum and minimum part sizes and other multipart upload specifications, /// see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/qfacts.html">Multipart /// upload limits</a> in the <i>Amazon S3 User Guide</i>. /// </para> /// <note> /// <para> /// Instead of using an existing object as part data, you might use the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html">UploadPart</a> /// action and provide data in your request. /// </para> /// </note> /// <para> /// 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. /// </para> /// /// <para> /// For more information about using the <code>UploadPartCopy</code> operation, see the /// following: /// </para> /// <ul> <li> /// <para> /// For conceptual information about multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html">Uploading /// Objects Using Multipart Upload</a> in the <i>Amazon S3 User Guide</i>. /// </para> /// </li> <li> /// <para> /// For information about permissions required to use the multipart upload API, see <a /// href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html">Multipart /// Upload and Permissions</a> in the <i>Amazon S3 User Guide</i>. /// </para> /// </li> <li> /// <para> /// For information about copying objects using a single atomic action vs. a multipart /// upload, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectOperations.html">Operations /// on Objects</a> in the <i>Amazon S3 User Guide</i>. /// </para> /// </li> <li> /// <para> /// For information about using server-side encryption with customer-provided encryption /// keys with the <code>UploadPartCopy</code> operation, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html">CopyObject</a> /// and <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html">UploadPart</a>. /// </para> /// </li> </ul> /// <para> /// Note the following additional considerations about the request headers <code>x-amz-copy-source-if-match</code>, /// <code>x-amz-copy-source-if-none-match</code>, <code>x-amz-copy-source-if-unmodified-since</code>, /// and <code>x-amz-copy-source-if-modified-since</code>: /// </para> /// /// <para> /// /// </para> /// <ul> <li> /// <para> /// <b>Consideration 1</b> - If both of the <code>x-amz-copy-source-if-match</code> and /// <code>x-amz-copy-source-if-unmodified-since</code> headers are present in the request /// as follows: /// </para> /// /// <para> /// <code>x-amz-copy-source-if-match</code> condition evaluates to <code>true</code>, /// and; /// </para> /// /// <para> /// <code>x-amz-copy-source-if-unmodified-since</code> condition evaluates to <code>false</code>; /// </para> /// /// <para> /// Amazon S3 returns <code>200 OK</code> and copies the data. /// </para> /// </li> <li> /// <para> /// <b>Consideration 2</b> - If both of the <code>x-amz-copy-source-if-none-match</code> /// and <code>x-amz-copy-source-if-modified-since</code> headers are present in the request /// as follows: /// </para> /// /// <para> /// <code>x-amz-copy-source-if-none-match</code> condition evaluates to <code>false</code>, /// and; /// </para> /// /// <para> /// <code>x-amz-copy-source-if-modified-since</code> condition evaluates to <code>true</code>; /// </para> /// /// <para> /// Amazon S3 returns <code>412 Precondition Failed</code> response code. /// </para> /// </li> </ul> <dl> <dt>Versioning</dt> <dd> /// <para> /// If your bucket has versioning enabled, you could have multiple versions of the same /// object. By default, <code>x-amz-copy-source</code> 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 <code>x-amz-copy-source</code>, Amazon S3 returns a 404 error, /// because the object does not exist. If you specify versionId in the <code>x-amz-copy-source</code> /// 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 <code>x-amz-copy-source</code>. /// /// </para> /// /// <para> /// You can optionally specify a specific version of the source object to copy by adding /// the <code>versionId</code> subresource as shown in the following example: /// </para> /// /// <para> /// <code>x-amz-copy-source: /bucket/object?versionId=version id</code> /// </para> /// </dd> <dt>Special errors</dt> <dd> <ul> <li> <ul> <li> /// <para> /// <i>Code: NoSuchUpload</i> /// </para> /// </li> <li> /// <para> /// <i>Cause: The specified multipart upload does not exist. The upload ID might be invalid, /// or the multipart upload might have been aborted or completed.</i> /// </para> /// </li> <li> /// <para> /// <i>HTTP Status Code: 404 Not Found</i> /// </para> /// </li> </ul> </li> <li> <ul> <li> /// <para> /// <i>Code: InvalidRequest</i> /// </para> /// </li> <li> /// <para> /// <i>Cause: The specified copy source is not supported as a byte-range copy source.</i> /// /// </para> /// </li> <li> /// <para> /// <i>HTTP Status Code: 400 Bad Request</i> /// </para> /// </li> </ul> </li> </ul> </dd> </dl> /// <para> /// The following operations are related to <code>UploadPartCopy</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html">CreateMultipartUpload</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html">UploadPart</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html">CompleteMultipartUpload</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html">AbortMultipartUpload</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html">ListParts</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html">ListMultipartUploads</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="sourceBucket">A property of CopyPartRequest used to execute the CopyPart service method.</param> /// <param name="sourceKey">A property of CopyPartRequest used to execute the CopyPart service method.</param> /// <param name="destinationBucket">The bucket name. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>. When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</param> /// <param name="destinationKey">A property of CopyPartRequest used to execute the CopyPart service method.</param> /// <param name="uploadId">Upload ID identifying the multipart upload whose part is being copied.</param> /// /// <returns>The response from the CopyPart service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/UploadPartCopy">REST API Reference for CopyPart Operation</seealso> CopyPartResponse CopyPart(string sourceBucket, string sourceKey, string destinationBucket, string destinationKey, string uploadId); /// <summary> /// Uploads a part by copying data from an existing object as data source. You specify /// the data source by adding the request header <code>x-amz-copy-source</code> in your /// request and a byte range by adding the request header <code>x-amz-copy-source-range</code> /// in your request. /// /// /// <para> /// For information about maximum and minimum part sizes and other multipart upload specifications, /// see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/qfacts.html">Multipart /// upload limits</a> in the <i>Amazon S3 User Guide</i>. /// </para> /// <note> /// <para> /// Instead of using an existing object as part data, you might use the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html">UploadPart</a> /// action and provide data in your request. /// </para> /// </note> /// <para> /// 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. /// </para> /// /// <para> /// For more information about using the <code>UploadPartCopy</code> operation, see the /// following: /// </para> /// <ul> <li> /// <para> /// For conceptual information about multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html">Uploading /// Objects Using Multipart Upload</a> in the <i>Amazon S3 User Guide</i>. /// </para> /// </li> <li> /// <para> /// For information about permissions required to use the multipart upload API, see <a /// href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html">Multipart /// Upload and Permissions</a> in the <i>Amazon S3 User Guide</i>. /// </para> /// </li> <li> /// <para> /// For information about copying objects using a single atomic action vs. a multipart /// upload, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectOperations.html">Operations /// on Objects</a> in the <i>Amazon S3 User Guide</i>. /// </para> /// </li> <li> /// <para> /// For information about using server-side encryption with customer-provided encryption /// keys with the <code>UploadPartCopy</code> operation, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html">CopyObject</a> /// and <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html">UploadPart</a>. /// </para> /// </li> </ul> /// <para> /// Note the following additional considerations about the request headers <code>x-amz-copy-source-if-match</code>, /// <code>x-amz-copy-source-if-none-match</code>, <code>x-amz-copy-source-if-unmodified-since</code>, /// and <code>x-amz-copy-source-if-modified-since</code>: /// </para> /// /// <para> /// /// </para> /// <ul> <li> /// <para> /// <b>Consideration 1</b> - If both of the <code>x-amz-copy-source-if-match</code> and /// <code>x-amz-copy-source-if-unmodified-since</code> headers are present in the request /// as follows: /// </para> /// /// <para> /// <code>x-amz-copy-source-if-match</code> condition evaluates to <code>true</code>, /// and; /// </para> /// /// <para> /// <code>x-amz-copy-source-if-unmodified-since</code> condition evaluates to <code>false</code>; /// </para> /// /// <para> /// Amazon S3 returns <code>200 OK</code> and copies the data. /// </para> /// </li> <li> /// <para> /// <b>Consideration 2</b> - If both of the <code>x-amz-copy-source-if-none-match</code> /// and <code>x-amz-copy-source-if-modified-since</code> headers are present in the request /// as follows: /// </para> /// /// <para> /// <code>x-amz-copy-source-if-none-match</code> condition evaluates to <code>false</code>, /// and; /// </para> /// /// <para> /// <code>x-amz-copy-source-if-modified-since</code> condition evaluates to <code>true</code>; /// </para> /// /// <para> /// Amazon S3 returns <code>412 Precondition Failed</code> response code. /// </para> /// </li> </ul> <dl> <dt>Versioning</dt> <dd> /// <para> /// If your bucket has versioning enabled, you could have multiple versions of the same /// object. By default, <code>x-amz-copy-source</code> 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 <code>x-amz-copy-source</code>, Amazon S3 returns a 404 error, /// because the object does not exist. If you specify versionId in the <code>x-amz-copy-source</code> /// 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 <code>x-amz-copy-source</code>. /// /// </para> /// /// <para> /// You can optionally specify a specific version of the source object to copy by adding /// the <code>versionId</code> subresource as shown in the following example: /// </para> /// /// <para> /// <code>x-amz-copy-source: /bucket/object?versionId=version id</code> /// </para> /// </dd> <dt>Special errors</dt> <dd> <ul> <li> <ul> <li> /// <para> /// <i>Code: NoSuchUpload</i> /// </para> /// </li> <li> /// <para> /// <i>Cause: The specified multipart upload does not exist. The upload ID might be invalid, /// or the multipart upload might have been aborted or completed.</i> /// </para> /// </li> <li> /// <para> /// <i>HTTP Status Code: 404 Not Found</i> /// </para> /// </li> </ul> </li> <li> <ul> <li> /// <para> /// <i>Code: InvalidRequest</i> /// </para> /// </li> <li> /// <para> /// <i>Cause: The specified copy source is not supported as a byte-range copy source.</i> /// /// </para> /// </li> <li> /// <para> /// <i>HTTP Status Code: 400 Bad Request</i> /// </para> /// </li> </ul> </li> </ul> </dd> </dl> /// <para> /// The following operations are related to <code>UploadPartCopy</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html">CreateMultipartUpload</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html">UploadPart</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html">CompleteMultipartUpload</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html">AbortMultipartUpload</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html">ListParts</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html">ListMultipartUploads</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="sourceBucket">A property of CopyPartRequest used to execute the CopyPart service method.</param> /// <param name="sourceKey">A property of CopyPartRequest used to execute the CopyPart service method.</param> /// <param name="sourceVersionId">A property of CopyPartRequest used to execute the CopyPart service method.</param> /// <param name="destinationBucket">The bucket name. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>. When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</param> /// <param name="destinationKey">A property of CopyPartRequest used to execute the CopyPart service method.</param> /// <param name="uploadId">Upload ID identifying the multipart upload whose part is being copied.</param> /// /// <returns>The response from the CopyPart service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/UploadPartCopy">REST API Reference for CopyPart Operation</seealso> CopyPartResponse CopyPart(string sourceBucket, string sourceKey, string sourceVersionId, string destinationBucket, string destinationKey, string uploadId); /// <summary> /// Uploads a part by copying data from an existing object as data source. You specify /// the data source by adding the request header <code>x-amz-copy-source</code> in your /// request and a byte range by adding the request header <code>x-amz-copy-source-range</code> /// in your request. /// /// /// <para> /// For information about maximum and minimum part sizes and other multipart upload specifications, /// see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/qfacts.html">Multipart /// upload limits</a> in the <i>Amazon S3 User Guide</i>. /// </para> /// <note> /// <para> /// Instead of using an existing object as part data, you might use the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html">UploadPart</a> /// action and provide data in your request. /// </para> /// </note> /// <para> /// 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. /// </para> /// /// <para> /// For more information about using the <code>UploadPartCopy</code> operation, see the /// following: /// </para> /// <ul> <li> /// <para> /// For conceptual information about multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html">Uploading /// Objects Using Multipart Upload</a> in the <i>Amazon S3 User Guide</i>. /// </para> /// </li> <li> /// <para> /// For information about permissions required to use the multipart upload API, see <a /// href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html">Multipart /// Upload and Permissions</a> in the <i>Amazon S3 User Guide</i>. /// </para> /// </li> <li> /// <para> /// For information about copying objects using a single atomic action vs. a multipart /// upload, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectOperations.html">Operations /// on Objects</a> in the <i>Amazon S3 User Guide</i>. /// </para> /// </li> <li> /// <para> /// For information about using server-side encryption with customer-provided encryption /// keys with the <code>UploadPartCopy</code> operation, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html">CopyObject</a> /// and <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html">UploadPart</a>. /// </para> /// </li> </ul> /// <para> /// Note the following additional considerations about the request headers <code>x-amz-copy-source-if-match</code>, /// <code>x-amz-copy-source-if-none-match</code>, <code>x-amz-copy-source-if-unmodified-since</code>, /// and <code>x-amz-copy-source-if-modified-since</code>: /// </para> /// /// <para> /// /// </para> /// <ul> <li> /// <para> /// <b>Consideration 1</b> - If both of the <code>x-amz-copy-source-if-match</code> and /// <code>x-amz-copy-source-if-unmodified-since</code> headers are present in the request /// as follows: /// </para> /// /// <para> /// <code>x-amz-copy-source-if-match</code> condition evaluates to <code>true</code>, /// and; /// </para> /// /// <para> /// <code>x-amz-copy-source-if-unmodified-since</code> condition evaluates to <code>false</code>; /// </para> /// /// <para> /// Amazon S3 returns <code>200 OK</code> and copies the data. /// </para> /// </li> <li> /// <para> /// <b>Consideration 2</b> - If both of the <code>x-amz-copy-source-if-none-match</code> /// and <code>x-amz-copy-source-if-modified-since</code> headers are present in the request /// as follows: /// </para> /// /// <para> /// <code>x-amz-copy-source-if-none-match</code> condition evaluates to <code>false</code>, /// and; /// </para> /// /// <para> /// <code>x-amz-copy-source-if-modified-since</code> condition evaluates to <code>true</code>; /// </para> /// /// <para> /// Amazon S3 returns <code>412 Precondition Failed</code> response code. /// </para> /// </li> </ul> <dl> <dt>Versioning</dt> <dd> /// <para> /// If your bucket has versioning enabled, you could have multiple versions of the same /// object. By default, <code>x-amz-copy-source</code> 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 <code>x-amz-copy-source</code>, Amazon S3 returns a 404 error, /// because the object does not exist. If you specify versionId in the <code>x-amz-copy-source</code> /// 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 <code>x-amz-copy-source</code>. /// /// </para> /// /// <para> /// You can optionally specify a specific version of the source object to copy by adding /// the <code>versionId</code> subresource as shown in the following example: /// </para> /// /// <para> /// <code>x-amz-copy-source: /bucket/object?versionId=version id</code> /// </para> /// </dd> <dt>Special errors</dt> <dd> <ul> <li> <ul> <li> /// <para> /// <i>Code: NoSuchUpload</i> /// </para> /// </li> <li> /// <para> /// <i>Cause: The specified multipart upload does not exist. The upload ID might be invalid, /// or the multipart upload might have been aborted or completed.</i> /// </para> /// </li> <li> /// <para> /// <i>HTTP Status Code: 404 Not Found</i> /// </para> /// </li> </ul> </li> <li> <ul> <li> /// <para> /// <i>Code: InvalidRequest</i> /// </para> /// </li> <li> /// <para> /// <i>Cause: The specified copy source is not supported as a byte-range copy source.</i> /// /// </para> /// </li> <li> /// <para> /// <i>HTTP Status Code: 400 Bad Request</i> /// </para> /// </li> </ul> </li> </ul> </dd> </dl> /// <para> /// The following operations are related to <code>UploadPartCopy</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html">CreateMultipartUpload</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html">UploadPart</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html">CompleteMultipartUpload</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html">AbortMultipartUpload</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html">ListParts</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html">ListMultipartUploads</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the CopyPart service method.</param> /// /// <returns>The response from the CopyPart service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/UploadPartCopy">REST API Reference for CopyPart Operation</seealso> CopyPartResponse CopyPart(CopyPartRequest request); /// <summary> /// Initiates the asynchronous execution of the CopyPart operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the CopyPart operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCopyPart /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/UploadPartCopy">REST API Reference for CopyPart Operation</seealso> IAsyncResult BeginCopyPart(CopyPartRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the CopyPart operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginCopyPart.</param> /// /// <returns>Returns a CopyPartResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/UploadPartCopy">REST API Reference for CopyPart Operation</seealso> CopyPartResponse EndCopyPart(IAsyncResult asyncResult); #endregion #region DeleteBucket /// <summary> /// 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. /// /// /// <para> /// The following operations are related to <code>DeleteBucket</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html">DeleteObject</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="bucketName">Specifies the bucket being deleted.</param> /// /// <returns>The response from the DeleteBucket service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucket">REST API Reference for DeleteBucket Operation</seealso> DeleteBucketResponse DeleteBucket(string bucketName); /// <summary> /// 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. /// /// /// <para> /// The following operations are related to <code>DeleteBucket</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html">DeleteObject</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the DeleteBucket service method.</param> /// /// <returns>The response from the DeleteBucket service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucket">REST API Reference for DeleteBucket Operation</seealso> DeleteBucketResponse DeleteBucket(DeleteBucketRequest request); /// <summary> /// Initiates the asynchronous execution of the DeleteBucket operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the DeleteBucket operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteBucket /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucket">REST API Reference for DeleteBucket Operation</seealso> IAsyncResult BeginDeleteBucket(DeleteBucketRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the DeleteBucket operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteBucket.</param> /// /// <returns>Returns a DeleteBucketResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucket">REST API Reference for DeleteBucket Operation</seealso> DeleteBucketResponse EndDeleteBucket(IAsyncResult asyncResult); #endregion #region DeleteBucketAnalyticsConfiguration /// <summary> /// Deletes an analytics configuration for the bucket (specified by the analytics configuration /// ID). /// /// /// <para> /// To use this operation, you must have permissions to perform the <code>s3:PutAnalyticsConfiguration</code> /// action. The bucket owner has this permission by default. The bucket owner can grant /// this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions /// Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing /// Access Permissions to Your Amazon S3 Resources</a>. /// </para> /// /// <para> /// For information about the Amazon S3 analytics feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html">Amazon /// S3 Analytics – Storage Class Analysis</a>. /// </para> /// /// <para> /// The following operations are related to <code>DeleteBucketAnalyticsConfiguration</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAnalyticsConfiguration.html">GetBucketAnalyticsConfiguration</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketAnalyticsConfigurations.html">ListBucketAnalyticsConfigurations</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAnalyticsConfiguration.html">PutBucketAnalyticsConfiguration</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the DeleteBucketAnalyticsConfiguration service method.</param> /// /// <returns>The response from the DeleteBucketAnalyticsConfiguration service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketAnalyticsConfiguration">REST API Reference for DeleteBucketAnalyticsConfiguration Operation</seealso> DeleteBucketAnalyticsConfigurationResponse DeleteBucketAnalyticsConfiguration(DeleteBucketAnalyticsConfigurationRequest request); /// <summary> /// Initiates the asynchronous execution of the DeleteBucketAnalyticsConfiguration operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the DeleteBucketAnalyticsConfiguration operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteBucketAnalyticsConfiguration /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketAnalyticsConfiguration">REST API Reference for DeleteBucketAnalyticsConfiguration Operation</seealso> IAsyncResult BeginDeleteBucketAnalyticsConfiguration(DeleteBucketAnalyticsConfigurationRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the DeleteBucketAnalyticsConfiguration operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteBucketAnalyticsConfiguration.</param> /// /// <returns>Returns a DeleteBucketAnalyticsConfigurationResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketAnalyticsConfiguration">REST API Reference for DeleteBucketAnalyticsConfiguration Operation</seealso> DeleteBucketAnalyticsConfigurationResponse EndDeleteBucketAnalyticsConfiguration(IAsyncResult asyncResult); #endregion #region DeleteBucketEncryption /// <summary> /// This implementation of the DELETE action resets the default encryption for the bucket /// as server-side encryption with Amazon S3 managed keys (SSE-S3). For information about /// the bucket default encryption feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html">Amazon /// S3 Bucket Default Encryption</a> in the <i>Amazon S3 User Guide</i>. /// /// /// <para> /// To use this operation, you must have permissions to perform the <code>s3:PutEncryptionConfiguration</code> /// action. The bucket owner has this permission by default. The bucket owner can grant /// this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions /// Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing /// Access Permissions to your Amazon S3 Resources</a> in the <i>Amazon S3 User Guide</i>. /// </para> /// /// <para> /// The following operations are related to <code>DeleteBucketEncryption</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketEncryption.html">PutBucketEncryption</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketEncryption.html">GetBucketEncryption</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the DeleteBucketEncryption service method.</param> /// /// <returns>The response from the DeleteBucketEncryption service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketEncryption">REST API Reference for DeleteBucketEncryption Operation</seealso> DeleteBucketEncryptionResponse DeleteBucketEncryption(DeleteBucketEncryptionRequest request); /// <summary> /// Initiates the asynchronous execution of the DeleteBucketEncryption operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the DeleteBucketEncryption operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteBucketEncryption /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketEncryption">REST API Reference for DeleteBucketEncryption Operation</seealso> IAsyncResult BeginDeleteBucketEncryption(DeleteBucketEncryptionRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the DeleteBucketEncryption operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteBucketEncryption.</param> /// /// <returns>Returns a DeleteBucketEncryptionResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketEncryption">REST API Reference for DeleteBucketEncryption Operation</seealso> DeleteBucketEncryptionResponse EndDeleteBucketEncryption(IAsyncResult asyncResult); #endregion #region DeleteBucketIntelligentTieringConfiguration /// <summary> /// Deletes the S3 Intelligent-Tiering configuration from the specified bucket. /// /// /// <para> /// 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. /// </para> /// /// <para> /// 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. /// </para> /// /// <para> /// For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access">Storage /// class for automatically optimizing frequently and infrequently accessed objects</a>. /// </para> /// /// <para> /// Operations related to <code>DeleteBucketIntelligentTieringConfiguration</code> include: /// /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketIntelligentTieringConfiguration.html">GetBucketIntelligentTieringConfiguration</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketIntelligentTieringConfiguration.html">PutBucketIntelligentTieringConfiguration</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketIntelligentTieringConfigurations.html">ListBucketIntelligentTieringConfigurations</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the DeleteBucketIntelligentTieringConfiguration service method.</param> /// /// <returns>The response from the DeleteBucketIntelligentTieringConfiguration service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketIntelligentTieringConfiguration">REST API Reference for DeleteBucketIntelligentTieringConfiguration Operation</seealso> DeleteBucketIntelligentTieringConfigurationResponse DeleteBucketIntelligentTieringConfiguration(DeleteBucketIntelligentTieringConfigurationRequest request); /// <summary> /// Initiates the asynchronous execution of the DeleteBucketIntelligentTieringConfiguration operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the DeleteBucketIntelligentTieringConfiguration operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteBucketIntelligentTieringConfiguration /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketIntelligentTieringConfiguration">REST API Reference for DeleteBucketIntelligentTieringConfiguration Operation</seealso> IAsyncResult BeginDeleteBucketIntelligentTieringConfiguration(DeleteBucketIntelligentTieringConfigurationRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the DeleteBucketIntelligentTieringConfiguration operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteBucketIntelligentTieringConfiguration.</param> /// /// <returns>Returns a DeleteBucketIntelligentTieringConfigurationResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketIntelligentTieringConfiguration">REST API Reference for DeleteBucketIntelligentTieringConfiguration Operation</seealso> DeleteBucketIntelligentTieringConfigurationResponse EndDeleteBucketIntelligentTieringConfiguration(IAsyncResult asyncResult); #endregion #region DeleteBucketInventoryConfiguration /// <summary> /// Deletes an inventory configuration (identified by the inventory ID) from the bucket. /// /// /// <para> /// To use this operation, you must have permissions to perform the <code>s3:PutInventoryConfiguration</code> /// action. The bucket owner has this permission by default. The bucket owner can grant /// this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions /// Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing /// Access Permissions to Your Amazon S3 Resources</a>. /// </para> /// /// <para> /// For information about the Amazon S3 inventory feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html">Amazon /// S3 Inventory</a>. /// </para> /// /// <para> /// Operations related to <code>DeleteBucketInventoryConfiguration</code> include: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketInventoryConfiguration.html">GetBucketInventoryConfiguration</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketInventoryConfiguration.html">PutBucketInventoryConfiguration</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketInventoryConfigurations.html">ListBucketInventoryConfigurations</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the DeleteBucketInventoryConfiguration service method.</param> /// /// <returns>The response from the DeleteBucketInventoryConfiguration service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketInventoryConfiguration">REST API Reference for DeleteBucketInventoryConfiguration Operation</seealso> DeleteBucketInventoryConfigurationResponse DeleteBucketInventoryConfiguration(DeleteBucketInventoryConfigurationRequest request); /// <summary> /// Initiates the asynchronous execution of the DeleteBucketInventoryConfiguration operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the DeleteBucketInventoryConfiguration operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteBucketInventoryConfiguration /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketInventoryConfiguration">REST API Reference for DeleteBucketInventoryConfiguration Operation</seealso> IAsyncResult BeginDeleteBucketInventoryConfiguration(DeleteBucketInventoryConfigurationRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the DeleteBucketInventoryConfiguration operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteBucketInventoryConfiguration.</param> /// /// <returns>Returns a DeleteBucketInventoryConfigurationResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketInventoryConfiguration">REST API Reference for DeleteBucketInventoryConfiguration Operation</seealso> DeleteBucketInventoryConfigurationResponse EndDeleteBucketInventoryConfiguration(IAsyncResult asyncResult); #endregion #region DeleteBucketMetricsConfiguration /// <summary> /// 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. /// /// /// <para> /// To use this operation, you must have permissions to perform the <code>s3:PutMetricsConfiguration</code> /// action. The bucket owner has this permission by default. The bucket owner can grant /// this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions /// Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing /// Access Permissions to Your Amazon S3 Resources</a>. /// </para> /// /// <para> /// For information about CloudWatch request metrics for Amazon S3, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html">Monitoring /// Metrics with Amazon CloudWatch</a>. /// </para> /// /// <para> /// The following operations are related to <code>DeleteBucketMetricsConfiguration</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketMetricsConfiguration.html">GetBucketMetricsConfiguration</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html">PutBucketMetricsConfiguration</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketMetricsConfigurations.html">ListBucketMetricsConfigurations</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html">Monitoring /// Metrics with Amazon CloudWatch</a> /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the DeleteBucketMetricsConfiguration service method.</param> /// /// <returns>The response from the DeleteBucketMetricsConfiguration service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketMetricsConfiguration">REST API Reference for DeleteBucketMetricsConfiguration Operation</seealso> DeleteBucketMetricsConfigurationResponse DeleteBucketMetricsConfiguration(DeleteBucketMetricsConfigurationRequest request); /// <summary> /// Initiates the asynchronous execution of the DeleteBucketMetricsConfiguration operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the DeleteBucketMetricsConfiguration operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteBucketMetricsConfiguration /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketMetricsConfiguration">REST API Reference for DeleteBucketMetricsConfiguration Operation</seealso> IAsyncResult BeginDeleteBucketMetricsConfiguration(DeleteBucketMetricsConfigurationRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the DeleteBucketMetricsConfiguration operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteBucketMetricsConfiguration.</param> /// /// <returns>Returns a DeleteBucketMetricsConfigurationResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketMetricsConfiguration">REST API Reference for DeleteBucketMetricsConfiguration Operation</seealso> DeleteBucketMetricsConfigurationResponse EndDeleteBucketMetricsConfiguration(IAsyncResult asyncResult); #endregion #region DeleteBucketOwnershipControls /// <summary> /// Removes <code>OwnershipControls</code> for an Amazon S3 bucket. To use this operation, /// you must have the <code>s3:PutBucketOwnershipControls</code> permission. For more /// information about Amazon S3 permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying /// Permissions in a Policy</a>. /// /// /// <para> /// For information about Amazon S3 Object Ownership, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/about-object-ownership.html">Using /// Object Ownership</a>. /// </para> /// /// <para> /// The following operations are related to <code>DeleteBucketOwnershipControls</code>: /// </para> /// <ul> <li> /// <para> /// <a>GetBucketOwnershipControls</a> /// </para> /// </li> <li> /// <para> /// <a>PutBucketOwnershipControls</a> /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the DeleteBucketOwnershipControls service method.</param> /// /// <returns>The response from the DeleteBucketOwnershipControls service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketOwnershipControls">REST API Reference for DeleteBucketOwnershipControls Operation</seealso> DeleteBucketOwnershipControlsResponse DeleteBucketOwnershipControls(DeleteBucketOwnershipControlsRequest request); /// <summary> /// Initiates the asynchronous execution of the DeleteBucketOwnershipControls operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the DeleteBucketOwnershipControls operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteBucketOwnershipControls /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketOwnershipControls">REST API Reference for DeleteBucketOwnershipControls Operation</seealso> IAsyncResult BeginDeleteBucketOwnershipControls(DeleteBucketOwnershipControlsRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the DeleteBucketOwnershipControls operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteBucketOwnershipControls.</param> /// /// <returns>Returns a DeleteBucketOwnershipControlsResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketOwnershipControls">REST API Reference for DeleteBucketOwnershipControls Operation</seealso> DeleteBucketOwnershipControlsResponse EndDeleteBucketOwnershipControls(IAsyncResult asyncResult); #endregion #region DeleteBucketPolicy /// <summary> /// 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 <code>DeleteBucketPolicy</code> permissions on the specified bucket and belong /// to the bucket owner's account to use this operation. /// /// /// <para> /// If you don't have <code>DeleteBucketPolicy</code> permissions, Amazon S3 returns a /// <code>403 Access Denied</code> 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 <code>405 Method Not Allowed</code> error. /// </para> /// <important> /// <para> /// To ensure that bucket owners don't inadvertently lock themselves out of their own /// buckets, the root principal in a bucket owner's Amazon Web Services account can perform /// the <code>GetBucketPolicy</code>, <code>PutBucketPolicy</code>, and <code>DeleteBucketPolicy</code> /// API actions, even if their bucket policy explicitly denies the root principal's access. /// Bucket owner root principals can only be blocked from performing these API actions /// by VPC endpoint policies and Amazon Web Services Organizations policies. /// </para> /// </important> /// <para> /// For more information about bucket policies, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html">Using /// Bucket Policies and UserPolicies</a>. /// </para> /// /// <para> /// The following operations are related to <code>DeleteBucketPolicy</code> /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html">DeleteObject</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="bucketName">The bucket name.</param> /// /// <returns>The response from the DeleteBucketPolicy service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketPolicy">REST API Reference for DeleteBucketPolicy Operation</seealso> DeleteBucketPolicyResponse DeleteBucketPolicy(string bucketName); /// <summary> /// 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 <code>DeleteBucketPolicy</code> permissions on the specified bucket and belong /// to the bucket owner's account to use this operation. /// /// /// <para> /// If you don't have <code>DeleteBucketPolicy</code> permissions, Amazon S3 returns a /// <code>403 Access Denied</code> 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 <code>405 Method Not Allowed</code> error. /// </para> /// <important> /// <para> /// To ensure that bucket owners don't inadvertently lock themselves out of their own /// buckets, the root principal in a bucket owner's Amazon Web Services account can perform /// the <code>GetBucketPolicy</code>, <code>PutBucketPolicy</code>, and <code>DeleteBucketPolicy</code> /// API actions, even if their bucket policy explicitly denies the root principal's access. /// Bucket owner root principals can only be blocked from performing these API actions /// by VPC endpoint policies and Amazon Web Services Organizations policies. /// </para> /// </important> /// <para> /// For more information about bucket policies, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html">Using /// Bucket Policies and UserPolicies</a>. /// </para> /// /// <para> /// The following operations are related to <code>DeleteBucketPolicy</code> /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html">DeleteObject</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the DeleteBucketPolicy service method.</param> /// /// <returns>The response from the DeleteBucketPolicy service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketPolicy">REST API Reference for DeleteBucketPolicy Operation</seealso> DeleteBucketPolicyResponse DeleteBucketPolicy(DeleteBucketPolicyRequest request); /// <summary> /// Initiates the asynchronous execution of the DeleteBucketPolicy operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the DeleteBucketPolicy operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteBucketPolicy /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketPolicy">REST API Reference for DeleteBucketPolicy Operation</seealso> IAsyncResult BeginDeleteBucketPolicy(DeleteBucketPolicyRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the DeleteBucketPolicy operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteBucketPolicy.</param> /// /// <returns>Returns a DeleteBucketPolicyResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketPolicy">REST API Reference for DeleteBucketPolicy Operation</seealso> DeleteBucketPolicyResponse EndDeleteBucketPolicy(IAsyncResult asyncResult); #endregion #region DeleteBucketReplication /// <summary> /// Deletes the replication configuration from the bucket. /// /// /// <para> /// To use this operation, you must have permissions to perform the <code>s3:PutReplicationConfiguration</code> /// action. The bucket owner has these permissions by default and can grant it to others. /// For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions /// Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing /// Access Permissions to Your Amazon S3 Resources</a>. /// </para> /// <note> /// <para> /// It can take a while for the deletion of a replication configuration to fully propagate. /// </para> /// </note> /// <para> /// For information about replication configuration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html">Replication</a> /// in the <i>Amazon S3 User Guide</i>. /// </para> /// /// <para> /// The following operations are related to <code>DeleteBucketReplication</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketReplication.html">PutBucketReplication</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketReplication.html">GetBucketReplication</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the DeleteBucketReplication service method.</param> /// /// <returns>The response from the DeleteBucketReplication service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketReplication">REST API Reference for DeleteBucketReplication Operation</seealso> DeleteBucketReplicationResponse DeleteBucketReplication(DeleteBucketReplicationRequest request); /// <summary> /// Initiates the asynchronous execution of the DeleteBucketReplication operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the DeleteBucketReplication operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteBucketReplication /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketReplication">REST API Reference for DeleteBucketReplication Operation</seealso> IAsyncResult BeginDeleteBucketReplication(DeleteBucketReplicationRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the DeleteBucketReplication operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteBucketReplication.</param> /// /// <returns>Returns a DeleteBucketReplicationResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketReplication">REST API Reference for DeleteBucketReplication Operation</seealso> DeleteBucketReplicationResponse EndDeleteBucketReplication(IAsyncResult asyncResult); #endregion #region DeleteBucketTagging /// <summary> /// Deletes the tags from the bucket. /// /// /// <para> /// To use this operation, you must have permission to perform the <code>s3:PutBucketTagging</code> /// action. By default, the bucket owner has this permission and can grant this permission /// to others. /// </para> /// /// <para> /// The following operations are related to <code>DeleteBucketTagging</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketTagging.html">GetBucketTagging</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketTagging.html">PutBucketTagging</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="bucketName">The bucket that has the tag set to be removed.</param> /// /// <returns>The response from the DeleteBucketTagging service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketTagging">REST API Reference for DeleteBucketTagging Operation</seealso> DeleteBucketTaggingResponse DeleteBucketTagging(string bucketName); /// <summary> /// Deletes the tags from the bucket. /// /// /// <para> /// To use this operation, you must have permission to perform the <code>s3:PutBucketTagging</code> /// action. By default, the bucket owner has this permission and can grant this permission /// to others. /// </para> /// /// <para> /// The following operations are related to <code>DeleteBucketTagging</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketTagging.html">GetBucketTagging</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketTagging.html">PutBucketTagging</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the DeleteBucketTagging service method.</param> /// /// <returns>The response from the DeleteBucketTagging service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketTagging">REST API Reference for DeleteBucketTagging Operation</seealso> DeleteBucketTaggingResponse DeleteBucketTagging(DeleteBucketTaggingRequest request); /// <summary> /// Initiates the asynchronous execution of the DeleteBucketTagging operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the DeleteBucketTagging operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteBucketTagging /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketTagging">REST API Reference for DeleteBucketTagging Operation</seealso> IAsyncResult BeginDeleteBucketTagging(DeleteBucketTaggingRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the DeleteBucketTagging operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteBucketTagging.</param> /// /// <returns>Returns a DeleteBucketTaggingResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketTagging">REST API Reference for DeleteBucketTagging Operation</seealso> DeleteBucketTaggingResponse EndDeleteBucketTagging(IAsyncResult asyncResult); #endregion #region DeleteBucketWebsite /// <summary> /// This action removes the website configuration for a bucket. Amazon S3 returns a <code>200 /// OK</code> response upon successfully deleting a website configuration on the specified /// bucket. You will get a <code>200 OK</code> response if the website configuration you /// are trying to delete does not exist on the bucket. Amazon S3 returns a <code>404</code> /// response if the bucket specified in the request does not exist. /// /// /// <para> /// This DELETE action requires the <code>S3:DeleteBucketWebsite</code> 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 <code>S3:DeleteBucketWebsite</code> /// permission. /// </para> /// /// <para> /// For more information about hosting websites, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html">Hosting /// Websites on Amazon S3</a>. /// </para> /// /// <para> /// The following operations are related to <code>DeleteBucketWebsite</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketWebsite.html">GetBucketWebsite</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketWebsite.html">PutBucketWebsite</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="bucketName">The bucket name for which you want to remove the website configuration. </param> /// /// <returns>The response from the DeleteBucketWebsite service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketWebsite">REST API Reference for DeleteBucketWebsite Operation</seealso> DeleteBucketWebsiteResponse DeleteBucketWebsite(string bucketName); /// <summary> /// This action removes the website configuration for a bucket. Amazon S3 returns a <code>200 /// OK</code> response upon successfully deleting a website configuration on the specified /// bucket. You will get a <code>200 OK</code> response if the website configuration you /// are trying to delete does not exist on the bucket. Amazon S3 returns a <code>404</code> /// response if the bucket specified in the request does not exist. /// /// /// <para> /// This DELETE action requires the <code>S3:DeleteBucketWebsite</code> 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 <code>S3:DeleteBucketWebsite</code> /// permission. /// </para> /// /// <para> /// For more information about hosting websites, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html">Hosting /// Websites on Amazon S3</a>. /// </para> /// /// <para> /// The following operations are related to <code>DeleteBucketWebsite</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketWebsite.html">GetBucketWebsite</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketWebsite.html">PutBucketWebsite</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the DeleteBucketWebsite service method.</param> /// /// <returns>The response from the DeleteBucketWebsite service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketWebsite">REST API Reference for DeleteBucketWebsite Operation</seealso> DeleteBucketWebsiteResponse DeleteBucketWebsite(DeleteBucketWebsiteRequest request); /// <summary> /// Initiates the asynchronous execution of the DeleteBucketWebsite operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the DeleteBucketWebsite operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteBucketWebsite /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketWebsite">REST API Reference for DeleteBucketWebsite Operation</seealso> IAsyncResult BeginDeleteBucketWebsite(DeleteBucketWebsiteRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the DeleteBucketWebsite operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteBucketWebsite.</param> /// /// <returns>Returns a DeleteBucketWebsiteResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketWebsite">REST API Reference for DeleteBucketWebsite Operation</seealso> DeleteBucketWebsiteResponse EndDeleteBucketWebsite(IAsyncResult asyncResult); #endregion #region DeleteCORSConfiguration /// <summary> /// Deletes the <code>cors</code> configuration information set for the bucket. /// /// /// <para> /// To use this operation, you must have permission to perform the <code>s3:PutBucketCORS</code> /// action. The bucket owner has this permission by default and can grant this permission /// to others. /// </para> /// /// <para> /// For information about <code>cors</code>, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html">Enabling /// Cross-Origin Resource Sharing</a> in the <i>Amazon S3 User Guide</i>. /// </para> /// <p class="title"> <b>Related Resources</b> /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketCors.html">PutBucketCors</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTOPTIONSobject.html">RESTOPTIONSobject</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="bucketName">Specifies the bucket whose <code>cors</code> configuration is being deleted.</param> /// /// <returns>The response from the DeleteCORSConfiguration service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketCors">REST API Reference for DeleteCORSConfiguration Operation</seealso> DeleteCORSConfigurationResponse DeleteCORSConfiguration(string bucketName); /// <summary> /// Deletes the <code>cors</code> configuration information set for the bucket. /// /// /// <para> /// To use this operation, you must have permission to perform the <code>s3:PutBucketCORS</code> /// action. The bucket owner has this permission by default and can grant this permission /// to others. /// </para> /// /// <para> /// For information about <code>cors</code>, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html">Enabling /// Cross-Origin Resource Sharing</a> in the <i>Amazon S3 User Guide</i>. /// </para> /// <p class="title"> <b>Related Resources</b> /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketCors.html">PutBucketCors</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTOPTIONSobject.html">RESTOPTIONSobject</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the DeleteCORSConfiguration service method.</param> /// /// <returns>The response from the DeleteCORSConfiguration service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketCors">REST API Reference for DeleteCORSConfiguration Operation</seealso> DeleteCORSConfigurationResponse DeleteCORSConfiguration(DeleteCORSConfigurationRequest request); /// <summary> /// Initiates the asynchronous execution of the DeleteCORSConfiguration operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the DeleteCORSConfiguration operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteCORSConfiguration /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketCors">REST API Reference for DeleteCORSConfiguration Operation</seealso> IAsyncResult BeginDeleteCORSConfiguration(DeleteCORSConfigurationRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the DeleteCORSConfiguration operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteCORSConfiguration.</param> /// /// <returns>Returns a DeleteCORSConfigurationResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketCors">REST API Reference for DeleteCORSConfiguration Operation</seealso> DeleteCORSConfigurationResponse EndDeleteCORSConfiguration(IAsyncResult asyncResult); #endregion #region DeleteLifecycleConfiguration /// <summary> /// 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. /// /// /// <para> /// To use this operation, you must have permission to perform the <code>s3:PutLifecycleConfiguration</code> /// action. By default, the bucket owner has this permission and the bucket owner can /// grant this permission to others. /// </para> /// /// <para> /// There is usually some time lag before lifecycle configuration deletion is fully propagated /// to all the Amazon S3 systems. /// </para> /// /// <para> /// For more information about the object expiration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#intro-lifecycle-rules-actions">Elements /// to Describe Lifecycle Actions</a>. /// </para> /// /// <para> /// Related actions include: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html">PutBucketLifecycleConfiguration</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html">GetBucketLifecycleConfiguration</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="bucketName">The bucket name of the lifecycle to delete.</param> /// /// <returns>The response from the DeleteLifecycleConfiguration service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketLifecycle">REST API Reference for DeleteLifecycleConfiguration Operation</seealso> DeleteLifecycleConfigurationResponse DeleteLifecycleConfiguration(string bucketName); /// <summary> /// 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. /// /// /// <para> /// To use this operation, you must have permission to perform the <code>s3:PutLifecycleConfiguration</code> /// action. By default, the bucket owner has this permission and the bucket owner can /// grant this permission to others. /// </para> /// /// <para> /// There is usually some time lag before lifecycle configuration deletion is fully propagated /// to all the Amazon S3 systems. /// </para> /// /// <para> /// For more information about the object expiration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#intro-lifecycle-rules-actions">Elements /// to Describe Lifecycle Actions</a>. /// </para> /// /// <para> /// Related actions include: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html">PutBucketLifecycleConfiguration</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html">GetBucketLifecycleConfiguration</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the DeleteLifecycleConfiguration service method.</param> /// /// <returns>The response from the DeleteLifecycleConfiguration service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketLifecycle">REST API Reference for DeleteLifecycleConfiguration Operation</seealso> DeleteLifecycleConfigurationResponse DeleteLifecycleConfiguration(DeleteLifecycleConfigurationRequest request); /// <summary> /// Initiates the asynchronous execution of the DeleteLifecycleConfiguration operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the DeleteLifecycleConfiguration operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteLifecycleConfiguration /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketLifecycle">REST API Reference for DeleteLifecycleConfiguration Operation</seealso> IAsyncResult BeginDeleteLifecycleConfiguration(DeleteLifecycleConfigurationRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the DeleteLifecycleConfiguration operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteLifecycleConfiguration.</param> /// /// <returns>Returns a DeleteLifecycleConfigurationResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketLifecycle">REST API Reference for DeleteLifecycleConfiguration Operation</seealso> DeleteLifecycleConfigurationResponse EndDeleteLifecycleConfiguration(IAsyncResult asyncResult); #endregion #region DeleteObject /// <summary> /// 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. /// /// /// <para> /// To remove a specific version, 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, <code>x-amz-delete-marker</code>, to true. /// </para> /// /// <para> /// If the object you want to delete is in a bucket where the bucket versioning configuration /// is MFA Delete enabled, you must include the <code>x-amz-mfa</code> request header /// in the DELETE <code>versionId</code> request. Requests that include <code>x-amz-mfa</code> /// must use HTTPS. /// </para> /// /// <para> /// For more information about MFA Delete, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMFADelete.html">Using /// MFA Delete</a>. To see sample requests that use versioning, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectDELETE.html#ExampleVersionObjectDelete">Sample /// Request</a>. /// </para> /// /// <para> /// You can delete objects by explicitly calling DELETE Object or configure its lifecycle /// (<a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html">PutBucketLifecycle</a>) /// 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 <code>s3:DeleteObject</code>, /// <code>s3:DeleteObjectVersion</code>, and <code>s3:PutLifeCycleConfiguration</code> /// actions. /// </para> /// /// <para> /// The following action is related to <code>DeleteObject</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html">PutObject</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="bucketName">The bucket name of the bucket containing the object. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>. When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</param> /// <param name="key">Key name of the object to delete.</param> /// /// <returns>The response from the DeleteObject service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteObject">REST API Reference for DeleteObject Operation</seealso> DeleteObjectResponse DeleteObject(string bucketName, string key); /// <summary> /// 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. /// /// /// <para> /// To remove a specific version, 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, <code>x-amz-delete-marker</code>, to true. /// </para> /// /// <para> /// If the object you want to delete is in a bucket where the bucket versioning configuration /// is MFA Delete enabled, you must include the <code>x-amz-mfa</code> request header /// in the DELETE <code>versionId</code> request. Requests that include <code>x-amz-mfa</code> /// must use HTTPS. /// </para> /// /// <para> /// For more information about MFA Delete, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMFADelete.html">Using /// MFA Delete</a>. To see sample requests that use versioning, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectDELETE.html#ExampleVersionObjectDelete">Sample /// Request</a>. /// </para> /// /// <para> /// You can delete objects by explicitly calling DELETE Object or configure its lifecycle /// (<a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html">PutBucketLifecycle</a>) /// 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 <code>s3:DeleteObject</code>, /// <code>s3:DeleteObjectVersion</code>, and <code>s3:PutLifeCycleConfiguration</code> /// actions. /// </para> /// /// <para> /// The following action is related to <code>DeleteObject</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html">PutObject</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="bucketName">The bucket name of the bucket containing the object. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>. When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</param> /// <param name="key">Key name of the object to delete.</param> /// <param name="versionId">VersionId used to reference a specific version of the object.</param> /// /// <returns>The response from the DeleteObject service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteObject">REST API Reference for DeleteObject Operation</seealso> DeleteObjectResponse DeleteObject(string bucketName, string key, string versionId); /// <summary> /// 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. /// /// /// <para> /// To remove a specific version, 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, <code>x-amz-delete-marker</code>, to true. /// </para> /// /// <para> /// If the object you want to delete is in a bucket where the bucket versioning configuration /// is MFA Delete enabled, you must include the <code>x-amz-mfa</code> request header /// in the DELETE <code>versionId</code> request. Requests that include <code>x-amz-mfa</code> /// must use HTTPS. /// </para> /// /// <para> /// For more information about MFA Delete, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMFADelete.html">Using /// MFA Delete</a>. To see sample requests that use versioning, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectDELETE.html#ExampleVersionObjectDelete">Sample /// Request</a>. /// </para> /// /// <para> /// You can delete objects by explicitly calling DELETE Object or configure its lifecycle /// (<a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html">PutBucketLifecycle</a>) /// 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 <code>s3:DeleteObject</code>, /// <code>s3:DeleteObjectVersion</code>, and <code>s3:PutLifeCycleConfiguration</code> /// actions. /// </para> /// /// <para> /// The following action is related to <code>DeleteObject</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html">PutObject</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the DeleteObject service method.</param> /// /// <returns>The response from the DeleteObject service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteObject">REST API Reference for DeleteObject Operation</seealso> DeleteObjectResponse DeleteObject(DeleteObjectRequest request); /// <summary> /// Initiates the asynchronous execution of the DeleteObject operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the DeleteObject operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteObject /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteObject">REST API Reference for DeleteObject Operation</seealso> IAsyncResult BeginDeleteObject(DeleteObjectRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the DeleteObject operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteObject.</param> /// /// <returns>Returns a DeleteObjectResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteObject">REST API Reference for DeleteObject Operation</seealso> DeleteObjectResponse EndDeleteObject(IAsyncResult asyncResult); #endregion #region DeleteObjects /// <summary> /// 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. /// /// /// <para> /// 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. /// </para> /// /// <para> /// 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. /// </para> /// /// <para> /// 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html#MultiFactorAuthenticationDelete"> /// MFA Delete</a>. /// </para> /// /// <para> /// 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. /// </para> /// /// <para> /// The following operations are related to <code>DeleteObjects</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html">CreateMultipartUpload</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html">UploadPart</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html">CompleteMultipartUpload</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html">ListParts</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html">AbortMultipartUpload</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the DeleteObjects service method.</param> /// /// <returns>The response from the DeleteObjects service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteObjects">REST API Reference for DeleteObjects Operation</seealso> DeleteObjectsResponse DeleteObjects(DeleteObjectsRequest request); /// <summary> /// Initiates the asynchronous execution of the DeleteObjects operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the DeleteObjects operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteObjects /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteObjects">REST API Reference for DeleteObjects Operation</seealso> IAsyncResult BeginDeleteObjects(DeleteObjectsRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the DeleteObjects operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteObjects.</param> /// /// <returns>Returns a DeleteObjectsResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteObjects">REST API Reference for DeleteObjects Operation</seealso> DeleteObjectsResponse EndDeleteObjects(IAsyncResult asyncResult); #endregion #region DeleteObjectTagging /// <summary> /// Removes the entire tag set from the specified object. For more information about managing /// object tags, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html"> /// Object Tagging</a>. /// /// /// <para> /// To use this operation, you must have permission to perform the <code>s3:DeleteObjectTagging</code> /// action. /// </para> /// /// <para> /// To delete tags of a specific object version, add the <code>versionId</code> query /// parameter in the request. You will need permission for the <code>s3:DeleteObjectVersionTagging</code> /// action. /// </para> /// /// <para> /// The following operations are related to <code>DeleteObjectTagging</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObjectTagging.html">PutObjectTagging</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html">GetObjectTagging</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the DeleteObjectTagging service method.</param> /// /// <returns>The response from the DeleteObjectTagging service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteObjectTagging">REST API Reference for DeleteObjectTagging Operation</seealso> DeleteObjectTaggingResponse DeleteObjectTagging(DeleteObjectTaggingRequest request); /// <summary> /// Initiates the asynchronous execution of the DeleteObjectTagging operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the DeleteObjectTagging operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteObjectTagging /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteObjectTagging">REST API Reference for DeleteObjectTagging Operation</seealso> IAsyncResult BeginDeleteObjectTagging(DeleteObjectTaggingRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the DeleteObjectTagging operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteObjectTagging.</param> /// /// <returns>Returns a DeleteObjectTaggingResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteObjectTagging">REST API Reference for DeleteObjectTagging Operation</seealso> DeleteObjectTaggingResponse EndDeleteObjectTagging(IAsyncResult asyncResult); #endregion #region DeletePublicAccessBlock /// <summary> /// Removes the <code>PublicAccessBlock</code> configuration for an Amazon S3 bucket. /// To use this operation, you must have the <code>s3:PutBucketPublicAccessBlock</code> /// permission. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions /// Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing /// Access Permissions to Your Amazon S3 Resources</a>. /// /// /// <para> /// The following operations are related to <code>DeletePublicAccessBlock</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html">Using /// Amazon S3 Block Public Access</a> /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html">GetPublicAccessBlock</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutPublicAccessBlock.html">PutPublicAccessBlock</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketPolicyStatus.html">GetBucketPolicyStatus</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the DeletePublicAccessBlock service method.</param> /// /// <returns>The response from the DeletePublicAccessBlock service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeletePublicAccessBlock">REST API Reference for DeletePublicAccessBlock Operation</seealso> DeletePublicAccessBlockResponse DeletePublicAccessBlock(DeletePublicAccessBlockRequest request); /// <summary> /// Initiates the asynchronous execution of the DeletePublicAccessBlock operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the DeletePublicAccessBlock operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeletePublicAccessBlock /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeletePublicAccessBlock">REST API Reference for DeletePublicAccessBlock Operation</seealso> IAsyncResult BeginDeletePublicAccessBlock(DeletePublicAccessBlockRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the DeletePublicAccessBlock operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginDeletePublicAccessBlock.</param> /// /// <returns>Returns a DeletePublicAccessBlockResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeletePublicAccessBlock">REST API Reference for DeletePublicAccessBlock Operation</seealso> DeletePublicAccessBlockResponse EndDeletePublicAccessBlock(IAsyncResult asyncResult); #endregion #region GetACL /// <summary> /// This implementation of the <code>GET</code> action uses the <code>acl</code> subresource /// to return the access control list (ACL) of a bucket. To use <code>GET</code> to return /// the ACL of the bucket, you must have <code>READ_ACP</code> access to the bucket. If /// <code>READ_ACP</code> permission is granted to the anonymous user, you can return /// the ACL of the bucket without using an authorization header. /// /// /// <para> /// To use this API operation against an access point, provide the alias of the access /// point in place of the bucket name. /// </para> /// /// <para> /// To use this API operation against an Object Lambda access point, provide the alias /// of the Object Lambda access point in place of the bucket name. If the Object Lambda /// access point alias in a request is not valid, the error code <code>InvalidAccessPointAliasError</code> /// is returned. For more information about <code>InvalidAccessPointAliasError</code>, /// see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList">List /// of Error Codes</a>. /// </para> /// <note> /// <para> /// If your bucket uses the bucket owner enforced setting for S3 Object Ownership, requests /// to read ACLs are still supported and return the <code>bucket-owner-full-control</code> /// ACL with the owner being the account that created the bucket. For more information, /// see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html"> /// Controlling object ownership and disabling ACLs</a> in the <i>Amazon S3 User Guide</i>. /// </para> /// </note> /// <para> /// The following operations are related to <code>GetBucketAcl</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html">ListObjects</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="bucketName">Specifies the S3 bucket whose ACL is being requested. To use this API operation against an access point, provide the alias of the access point in place of the bucket name. To use this API operation against an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code <code>InvalidAccessPointAliasError</code> is returned. For more information about <code>InvalidAccessPointAliasError</code>, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList">List of Error Codes</a>.</param> /// /// <returns>The response from the GetACL service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketAcl">REST API Reference for GetACL Operation</seealso> GetACLResponse GetACL(string bucketName); /// <summary> /// This implementation of the <code>GET</code> action uses the <code>acl</code> subresource /// to return the access control list (ACL) of a bucket. To use <code>GET</code> to return /// the ACL of the bucket, you must have <code>READ_ACP</code> access to the bucket. If /// <code>READ_ACP</code> permission is granted to the anonymous user, you can return /// the ACL of the bucket without using an authorization header. /// /// /// <para> /// To use this API operation against an access point, provide the alias of the access /// point in place of the bucket name. /// </para> /// /// <para> /// To use this API operation against an Object Lambda access point, provide the alias /// of the Object Lambda access point in place of the bucket name. If the Object Lambda /// access point alias in a request is not valid, the error code <code>InvalidAccessPointAliasError</code> /// is returned. For more information about <code>InvalidAccessPointAliasError</code>, /// see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList">List /// of Error Codes</a>. /// </para> /// <note> /// <para> /// If your bucket uses the bucket owner enforced setting for S3 Object Ownership, requests /// to read ACLs are still supported and return the <code>bucket-owner-full-control</code> /// ACL with the owner being the account that created the bucket. For more information, /// see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html"> /// Controlling object ownership and disabling ACLs</a> in the <i>Amazon S3 User Guide</i>. /// </para> /// </note> /// <para> /// The following operations are related to <code>GetBucketAcl</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html">ListObjects</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the GetACL service method.</param> /// /// <returns>The response from the GetACL service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketAcl">REST API Reference for GetACL Operation</seealso> GetACLResponse GetACL(GetACLRequest request); /// <summary> /// Initiates the asynchronous execution of the GetACL operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the GetACL operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetACL /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketAcl">REST API Reference for GetACL Operation</seealso> IAsyncResult BeginGetACL(GetACLRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the GetACL operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginGetACL.</param> /// /// <returns>Returns a GetACLResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketAcl">REST API Reference for GetACL Operation</seealso> GetACLResponse EndGetACL(IAsyncResult asyncResult); #endregion #region GetBucketAccelerateConfiguration /// <summary> /// This implementation of the GET action uses the <code>accelerate</code> subresource /// to return the Transfer Acceleration state of a bucket, which is either <code>Enabled</code> /// or <code>Suspended</code>. Amazon S3 Transfer Acceleration is a bucket-level feature /// that enables you to perform faster data transfers to and from Amazon S3. /// /// /// <para> /// To use this operation, you must have permission to perform the <code>s3:GetAccelerateConfiguration</code> /// action. The bucket owner has this permission by default. The bucket owner can grant /// this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions /// Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing /// Access Permissions to your Amazon S3 Resources</a> in the <i>Amazon S3 User Guide</i>. /// </para> /// /// <para> /// You set the Transfer Acceleration state of an existing bucket to <code>Enabled</code> /// or <code>Suspended</code> by using the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAccelerateConfiguration.html">PutBucketAccelerateConfiguration</a> /// operation. /// </para> /// /// <para> /// A GET <code>accelerate</code> 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. /// </para> /// /// <para> /// For more information about transfer acceleration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html">Transfer /// Acceleration</a> in the Amazon S3 User Guide. /// </para> /// /// <para> /// The following operations are related to <code>GetBucketAccelerateConfiguration</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAccelerateConfiguration.html">PutBucketAccelerateConfiguration</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="bucketName">The name of the bucket for which the accelerate configuration is retrieved.</param> /// /// <returns>The response from the GetBucketAccelerateConfiguration service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketAccelerateConfiguration">REST API Reference for GetBucketAccelerateConfiguration Operation</seealso> GetBucketAccelerateConfigurationResponse GetBucketAccelerateConfiguration(string bucketName); /// <summary> /// This implementation of the GET action uses the <code>accelerate</code> subresource /// to return the Transfer Acceleration state of a bucket, which is either <code>Enabled</code> /// or <code>Suspended</code>. Amazon S3 Transfer Acceleration is a bucket-level feature /// that enables you to perform faster data transfers to and from Amazon S3. /// /// /// <para> /// To use this operation, you must have permission to perform the <code>s3:GetAccelerateConfiguration</code> /// action. The bucket owner has this permission by default. The bucket owner can grant /// this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions /// Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing /// Access Permissions to your Amazon S3 Resources</a> in the <i>Amazon S3 User Guide</i>. /// </para> /// /// <para> /// You set the Transfer Acceleration state of an existing bucket to <code>Enabled</code> /// or <code>Suspended</code> by using the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAccelerateConfiguration.html">PutBucketAccelerateConfiguration</a> /// operation. /// </para> /// /// <para> /// A GET <code>accelerate</code> 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. /// </para> /// /// <para> /// For more information about transfer acceleration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html">Transfer /// Acceleration</a> in the Amazon S3 User Guide. /// </para> /// /// <para> /// The following operations are related to <code>GetBucketAccelerateConfiguration</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAccelerateConfiguration.html">PutBucketAccelerateConfiguration</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the GetBucketAccelerateConfiguration service method.</param> /// /// <returns>The response from the GetBucketAccelerateConfiguration service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketAccelerateConfiguration">REST API Reference for GetBucketAccelerateConfiguration Operation</seealso> GetBucketAccelerateConfigurationResponse GetBucketAccelerateConfiguration(GetBucketAccelerateConfigurationRequest request); /// <summary> /// Initiates the asynchronous execution of the GetBucketAccelerateConfiguration operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the GetBucketAccelerateConfiguration operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketAccelerateConfiguration /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketAccelerateConfiguration">REST API Reference for GetBucketAccelerateConfiguration Operation</seealso> IAsyncResult BeginGetBucketAccelerateConfiguration(GetBucketAccelerateConfigurationRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the GetBucketAccelerateConfiguration operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginGetBucketAccelerateConfiguration.</param> /// /// <returns>Returns a GetBucketAccelerateConfigurationResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketAccelerateConfiguration">REST API Reference for GetBucketAccelerateConfiguration Operation</seealso> GetBucketAccelerateConfigurationResponse EndGetBucketAccelerateConfiguration(IAsyncResult asyncResult); #endregion #region GetBucketAnalyticsConfiguration /// <summary> /// This implementation of the GET action returns an analytics configuration (identified /// by the analytics configuration ID) from the bucket. /// /// /// <para> /// To use this operation, you must have permissions to perform the <code>s3:GetAnalyticsConfiguration</code> /// action. The bucket owner has this permission by default. The bucket owner can grant /// this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources"> /// Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing /// Access Permissions to Your Amazon S3 Resources</a> in the <i>Amazon S3 User Guide</i>. /// /// </para> /// /// <para> /// For information about Amazon S3 analytics feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html">Amazon /// S3 Analytics – Storage Class Analysis</a> in the <i>Amazon S3 User Guide</i>. /// </para> /// /// <para> /// The following operations are related to <code>GetBucketAnalyticsConfiguration</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketAnalyticsConfiguration.html">DeleteBucketAnalyticsConfiguration</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketAnalyticsConfigurations.html">ListBucketAnalyticsConfigurations</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAnalyticsConfiguration.html">PutBucketAnalyticsConfiguration</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the GetBucketAnalyticsConfiguration service method.</param> /// /// <returns>The response from the GetBucketAnalyticsConfiguration service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketAnalyticsConfiguration">REST API Reference for GetBucketAnalyticsConfiguration Operation</seealso> GetBucketAnalyticsConfigurationResponse GetBucketAnalyticsConfiguration(GetBucketAnalyticsConfigurationRequest request); /// <summary> /// Initiates the asynchronous execution of the GetBucketAnalyticsConfiguration operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the GetBucketAnalyticsConfiguration operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketAnalyticsConfiguration /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketAnalyticsConfiguration">REST API Reference for GetBucketAnalyticsConfiguration Operation</seealso> IAsyncResult BeginGetBucketAnalyticsConfiguration(GetBucketAnalyticsConfigurationRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the GetBucketAnalyticsConfiguration operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginGetBucketAnalyticsConfiguration.</param> /// /// <returns>Returns a GetBucketAnalyticsConfigurationResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketAnalyticsConfiguration">REST API Reference for GetBucketAnalyticsConfiguration Operation</seealso> GetBucketAnalyticsConfigurationResponse EndGetBucketAnalyticsConfiguration(IAsyncResult asyncResult); #endregion #region GetBucketEncryption /// <summary> /// Returns the default encryption configuration for an Amazon S3 bucket. By default, /// all buckets have a default encryption configuration that uses server-side encryption /// with Amazon S3 managed keys (SSE-S3). For information about the bucket default encryption /// feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html">Amazon /// S3 Bucket Default Encryption</a> in the <i>Amazon S3 User Guide</i>. /// /// /// <para> /// To use this operation, you must have permission to perform the <code>s3:GetEncryptionConfiguration</code> /// action. The bucket owner has this permission by default. The bucket owner can grant /// this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions /// Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing /// Access Permissions to Your Amazon S3 Resources</a>. /// </para> /// /// <para> /// The following operations are related to <code>GetBucketEncryption</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketEncryption.html">PutBucketEncryption</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketEncryption.html">DeleteBucketEncryption</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the GetBucketEncryption service method.</param> /// /// <returns>The response from the GetBucketEncryption service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketEncryption">REST API Reference for GetBucketEncryption Operation</seealso> GetBucketEncryptionResponse GetBucketEncryption(GetBucketEncryptionRequest request); /// <summary> /// Initiates the asynchronous execution of the GetBucketEncryption operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the GetBucketEncryption operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketEncryption /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketEncryption">REST API Reference for GetBucketEncryption Operation</seealso> IAsyncResult BeginGetBucketEncryption(GetBucketEncryptionRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the GetBucketEncryption operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginGetBucketEncryption.</param> /// /// <returns>Returns a GetBucketEncryptionResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketEncryption">REST API Reference for GetBucketEncryption Operation</seealso> GetBucketEncryptionResponse EndGetBucketEncryption(IAsyncResult asyncResult); #endregion #region GetBucketIntelligentTieringConfiguration /// <summary> /// Gets the S3 Intelligent-Tiering configuration from the specified bucket. /// /// /// <para> /// 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. /// </para> /// /// <para> /// 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. /// </para> /// /// <para> /// For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access">Storage /// class for automatically optimizing frequently and infrequently accessed objects</a>. /// </para> /// /// <para> /// Operations related to <code>GetBucketIntelligentTieringConfiguration</code> include: /// /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketIntelligentTieringConfiguration.html">DeleteBucketIntelligentTieringConfiguration</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketIntelligentTieringConfiguration.html">PutBucketIntelligentTieringConfiguration</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketIntelligentTieringConfigurations.html">ListBucketIntelligentTieringConfigurations</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the GetBucketIntelligentTieringConfiguration service method.</param> /// /// <returns>The response from the GetBucketIntelligentTieringConfiguration service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketIntelligentTieringConfiguration">REST API Reference for GetBucketIntelligentTieringConfiguration Operation</seealso> GetBucketIntelligentTieringConfigurationResponse GetBucketIntelligentTieringConfiguration(GetBucketIntelligentTieringConfigurationRequest request); /// <summary> /// Initiates the asynchronous execution of the GetBucketIntelligentTieringConfiguration operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the GetBucketIntelligentTieringConfiguration operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketIntelligentTieringConfiguration /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketIntelligentTieringConfiguration">REST API Reference for GetBucketIntelligentTieringConfiguration Operation</seealso> IAsyncResult BeginGetBucketIntelligentTieringConfiguration(GetBucketIntelligentTieringConfigurationRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the GetBucketIntelligentTieringConfiguration operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginGetBucketIntelligentTieringConfiguration.</param> /// /// <returns>Returns a GetBucketIntelligentTieringConfigurationResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketIntelligentTieringConfiguration">REST API Reference for GetBucketIntelligentTieringConfiguration Operation</seealso> GetBucketIntelligentTieringConfigurationResponse EndGetBucketIntelligentTieringConfiguration(IAsyncResult asyncResult); #endregion #region GetBucketInventoryConfiguration /// <summary> /// Returns an inventory configuration (identified by the inventory configuration ID) /// from the bucket. /// /// /// <para> /// To use this operation, you must have permissions to perform the <code>s3:GetInventoryConfiguration</code> /// action. The bucket owner has this permission by default and can grant this permission /// to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions /// Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing /// Access Permissions to Your Amazon S3 Resources</a>. /// </para> /// /// <para> /// For information about the Amazon S3 inventory feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html">Amazon /// S3 Inventory</a>. /// </para> /// /// <para> /// The following operations are related to <code>GetBucketInventoryConfiguration</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketInventoryConfiguration.html">DeleteBucketInventoryConfiguration</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketInventoryConfigurations.html">ListBucketInventoryConfigurations</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketInventoryConfiguration.html">PutBucketInventoryConfiguration</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the GetBucketInventoryConfiguration service method.</param> /// /// <returns>The response from the GetBucketInventoryConfiguration service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketInventoryConfiguration">REST API Reference for GetBucketInventoryConfiguration Operation</seealso> GetBucketInventoryConfigurationResponse GetBucketInventoryConfiguration(GetBucketInventoryConfigurationRequest request); /// <summary> /// Initiates the asynchronous execution of the GetBucketInventoryConfiguration operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the GetBucketInventoryConfiguration operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketInventoryConfiguration /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketInventoryConfiguration">REST API Reference for GetBucketInventoryConfiguration Operation</seealso> IAsyncResult BeginGetBucketInventoryConfiguration(GetBucketInventoryConfigurationRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the GetBucketInventoryConfiguration operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginGetBucketInventoryConfiguration.</param> /// /// <returns>Returns a GetBucketInventoryConfigurationResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketInventoryConfiguration">REST API Reference for GetBucketInventoryConfiguration Operation</seealso> GetBucketInventoryConfigurationResponse EndGetBucketInventoryConfiguration(IAsyncResult asyncResult); #endregion #region GetBucketLocation /// <summary> /// Returns the Region the bucket resides in. You set the bucket's Region using the <code>LocationConstraint</code> /// request parameter in a <code>CreateBucket</code> request. For more information, see /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a>. /// /// /// <para> /// To use this API operation against an access point, provide the alias of the access /// point in place of the bucket name. /// </para> /// /// <para> /// To use this API operation against an Object Lambda access point, provide the alias /// of the Object Lambda access point in place of the bucket name. If the Object Lambda /// access point alias in a request is not valid, the error code <code>InvalidAccessPointAliasError</code> /// is returned. For more information about <code>InvalidAccessPointAliasError</code>, /// see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList">List /// of Error Codes</a>. /// </para> /// <note> /// <para> /// We recommend that you use <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadBucket.html">HeadBucket</a> /// to return the Region that a bucket resides in. For backward compatibility, Amazon /// S3 continues to support GetBucketLocation. /// </para> /// </note> /// <para> /// The following operations are related to <code>GetBucketLocation</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="bucketName">The name of the bucket for which to get the location. To use this API operation against an access point, provide the alias of the access point in place of the bucket name. To use this API operation against an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code <code>InvalidAccessPointAliasError</code> is returned. For more information about <code>InvalidAccessPointAliasError</code>, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList">List of Error Codes</a>.</param> /// /// <returns>The response from the GetBucketLocation service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketLocation">REST API Reference for GetBucketLocation Operation</seealso> GetBucketLocationResponse GetBucketLocation(string bucketName); /// <summary> /// Returns the Region the bucket resides in. You set the bucket's Region using the <code>LocationConstraint</code> /// request parameter in a <code>CreateBucket</code> request. For more information, see /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a>. /// /// /// <para> /// To use this API operation against an access point, provide the alias of the access /// point in place of the bucket name. /// </para> /// /// <para> /// To use this API operation against an Object Lambda access point, provide the alias /// of the Object Lambda access point in place of the bucket name. If the Object Lambda /// access point alias in a request is not valid, the error code <code>InvalidAccessPointAliasError</code> /// is returned. For more information about <code>InvalidAccessPointAliasError</code>, /// see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList">List /// of Error Codes</a>. /// </para> /// <note> /// <para> /// We recommend that you use <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadBucket.html">HeadBucket</a> /// to return the Region that a bucket resides in. For backward compatibility, Amazon /// S3 continues to support GetBucketLocation. /// </para> /// </note> /// <para> /// The following operations are related to <code>GetBucketLocation</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the GetBucketLocation service method.</param> /// /// <returns>The response from the GetBucketLocation service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketLocation">REST API Reference for GetBucketLocation Operation</seealso> GetBucketLocationResponse GetBucketLocation(GetBucketLocationRequest request); /// <summary> /// Initiates the asynchronous execution of the GetBucketLocation operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the GetBucketLocation operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketLocation /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketLocation">REST API Reference for GetBucketLocation Operation</seealso> IAsyncResult BeginGetBucketLocation(GetBucketLocationRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the GetBucketLocation operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginGetBucketLocation.</param> /// /// <returns>Returns a GetBucketLocationResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketLocation">REST API Reference for GetBucketLocation Operation</seealso> GetBucketLocationResponse EndGetBucketLocation(IAsyncResult asyncResult); #endregion #region GetBucketLogging /// <summary> /// Returns the logging status of a bucket and the permissions users have to view and /// modify that status. /// /// /// <para> /// The following operations are related to <code>GetBucketLogging</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLogging.html">PutBucketLogging</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="bucketName">The bucket name for which to get the logging information.</param> /// /// <returns>The response from the GetBucketLogging service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketLogging">REST API Reference for GetBucketLogging Operation</seealso> GetBucketLoggingResponse GetBucketLogging(string bucketName); /// <summary> /// Returns the logging status of a bucket and the permissions users have to view and /// modify that status. /// /// /// <para> /// The following operations are related to <code>GetBucketLogging</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLogging.html">PutBucketLogging</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the GetBucketLogging service method.</param> /// /// <returns>The response from the GetBucketLogging service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketLogging">REST API Reference for GetBucketLogging Operation</seealso> GetBucketLoggingResponse GetBucketLogging(GetBucketLoggingRequest request); /// <summary> /// Initiates the asynchronous execution of the GetBucketLogging operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the GetBucketLogging operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketLogging /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketLogging">REST API Reference for GetBucketLogging Operation</seealso> IAsyncResult BeginGetBucketLogging(GetBucketLoggingRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the GetBucketLogging operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginGetBucketLogging.</param> /// /// <returns>Returns a GetBucketLoggingResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketLogging">REST API Reference for GetBucketLogging Operation</seealso> GetBucketLoggingResponse EndGetBucketLogging(IAsyncResult asyncResult); #endregion #region GetBucketMetricsConfiguration /// <summary> /// Gets a metrics configuration (specified by the metrics configuration ID) from the /// bucket. Note that this doesn't include the daily storage metrics. /// /// /// <para> /// To use this operation, you must have permissions to perform the <code>s3:GetMetricsConfiguration</code> /// action. The bucket owner has this permission by default. The bucket owner can grant /// this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions /// Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing /// Access Permissions to Your Amazon S3 Resources</a>. /// </para> /// /// <para> /// For information about CloudWatch request metrics for Amazon S3, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html">Monitoring /// Metrics with Amazon CloudWatch</a>. /// </para> /// /// <para> /// The following operations are related to <code>GetBucketMetricsConfiguration</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html">PutBucketMetricsConfiguration</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetricsConfiguration.html">DeleteBucketMetricsConfiguration</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketMetricsConfigurations.html">ListBucketMetricsConfigurations</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html">Monitoring /// Metrics with Amazon CloudWatch</a> /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the GetBucketMetricsConfiguration service method.</param> /// /// <returns>The response from the GetBucketMetricsConfiguration service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketMetricsConfiguration">REST API Reference for GetBucketMetricsConfiguration Operation</seealso> GetBucketMetricsConfigurationResponse GetBucketMetricsConfiguration(GetBucketMetricsConfigurationRequest request); /// <summary> /// Initiates the asynchronous execution of the GetBucketMetricsConfiguration operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the GetBucketMetricsConfiguration operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketMetricsConfiguration /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketMetricsConfiguration">REST API Reference for GetBucketMetricsConfiguration Operation</seealso> IAsyncResult BeginGetBucketMetricsConfiguration(GetBucketMetricsConfigurationRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the GetBucketMetricsConfiguration operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginGetBucketMetricsConfiguration.</param> /// /// <returns>Returns a GetBucketMetricsConfigurationResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketMetricsConfiguration">REST API Reference for GetBucketMetricsConfiguration Operation</seealso> GetBucketMetricsConfigurationResponse EndGetBucketMetricsConfiguration(IAsyncResult asyncResult); #endregion #region GetBucketNotification /// <summary> /// Returns the notification configuration of a bucket. /// /// /// <para> /// If notifications are not enabled on the bucket, the action returns an empty <code>NotificationConfiguration</code> /// element. /// </para> /// /// <para> /// 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 <code>s3:GetBucketNotification</code> /// permission. /// </para> /// /// <para> /// To use this API operation against an access point, provide the alias of the access /// point in place of the bucket name. /// </para> /// /// <para> /// To use this API operation against an Object Lambda access point, provide the alias /// of the Object Lambda access point in place of the bucket name. If the Object Lambda /// access point alias in a request is not valid, the error code <code>InvalidAccessPointAliasError</code> /// is returned. For more information about <code>InvalidAccessPointAliasError</code>, /// see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList">List /// of Error Codes</a>. /// </para> /// /// <para> /// For more information about setting and reading the notification configuration on a /// bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html">Setting /// Up Notification of Bucket Events</a>. For more information about bucket policies, /// see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html">Using /// Bucket Policies</a>. /// </para> /// /// <para> /// The following action is related to <code>GetBucketNotification</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketNotification.html">PutBucketNotification</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="bucketName">The name of the bucket for which to get the notification configuration. To use this API operation against an access point, provide the alias of the access point in place of the bucket name. To use this API operation against an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code <code>InvalidAccessPointAliasError</code> is returned. For more information about <code>InvalidAccessPointAliasError</code>, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList">List of Error Codes</a>.</param> /// /// <returns>The response from the GetBucketNotification service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketNotificationConfiguration">REST API Reference for GetBucketNotification Operation</seealso> GetBucketNotificationResponse GetBucketNotification(string bucketName); /// <summary> /// Returns the notification configuration of a bucket. /// /// /// <para> /// If notifications are not enabled on the bucket, the action returns an empty <code>NotificationConfiguration</code> /// element. /// </para> /// /// <para> /// 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 <code>s3:GetBucketNotification</code> /// permission. /// </para> /// /// <para> /// To use this API operation against an access point, provide the alias of the access /// point in place of the bucket name. /// </para> /// /// <para> /// To use this API operation against an Object Lambda access point, provide the alias /// of the Object Lambda access point in place of the bucket name. If the Object Lambda /// access point alias in a request is not valid, the error code <code>InvalidAccessPointAliasError</code> /// is returned. For more information about <code>InvalidAccessPointAliasError</code>, /// see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList">List /// of Error Codes</a>. /// </para> /// /// <para> /// For more information about setting and reading the notification configuration on a /// bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html">Setting /// Up Notification of Bucket Events</a>. For more information about bucket policies, /// see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html">Using /// Bucket Policies</a>. /// </para> /// /// <para> /// The following action is related to <code>GetBucketNotification</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketNotification.html">PutBucketNotification</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the GetBucketNotification service method.</param> /// /// <returns>The response from the GetBucketNotification service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketNotificationConfiguration">REST API Reference for GetBucketNotification Operation</seealso> GetBucketNotificationResponse GetBucketNotification(GetBucketNotificationRequest request); /// <summary> /// Initiates the asynchronous execution of the GetBucketNotification operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the GetBucketNotification operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketNotification /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketNotificationConfiguration">REST API Reference for GetBucketNotification Operation</seealso> IAsyncResult BeginGetBucketNotification(GetBucketNotificationRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the GetBucketNotification operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginGetBucketNotification.</param> /// /// <returns>Returns a GetBucketNotificationResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketNotificationConfiguration">REST API Reference for GetBucketNotification Operation</seealso> GetBucketNotificationResponse EndGetBucketNotification(IAsyncResult asyncResult); #endregion #region GetBucketOwnershipControls /// <summary> /// Retrieves <code>OwnershipControls</code> for an Amazon S3 bucket. To use this operation, /// you must have the <code>s3:GetBucketOwnershipControls</code> permission. For more /// information about Amazon S3 permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html">Specifying /// permissions in a policy</a>. /// /// /// <para> /// For information about Amazon S3 Object Ownership, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html">Using /// Object Ownership</a>. /// </para> /// /// <para> /// The following operations are related to <code>GetBucketOwnershipControls</code>: /// </para> /// <ul> <li> /// <para> /// <a>PutBucketOwnershipControls</a> /// </para> /// </li> <li> /// <para> /// <a>DeleteBucketOwnershipControls</a> /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the GetBucketOwnershipControls service method.</param> /// /// <returns>The response from the GetBucketOwnershipControls service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketOwnershipControls">REST API Reference for GetBucketOwnershipControls Operation</seealso> GetBucketOwnershipControlsResponse GetBucketOwnershipControls(GetBucketOwnershipControlsRequest request); /// <summary> /// Initiates the asynchronous execution of the GetBucketOwnershipControls operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the GetBucketOwnershipControls operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketOwnershipControls /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketOwnershipControls">REST API Reference for GetBucketOwnershipControls Operation</seealso> IAsyncResult BeginGetBucketOwnershipControls(GetBucketOwnershipControlsRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the GetBucketOwnershipControls operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginGetBucketOwnershipControls.</param> /// /// <returns>Returns a GetBucketOwnershipControlsResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketOwnershipControls">REST API Reference for GetBucketOwnershipControls Operation</seealso> GetBucketOwnershipControlsResponse EndGetBucketOwnershipControls(IAsyncResult asyncResult); #endregion #region GetBucketPolicy /// <summary> /// 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 <code>GetBucketPolicy</code> permissions on the specified bucket /// and belong to the bucket owner's account in order to use this operation. /// /// /// <para> /// If you don't have <code>GetBucketPolicy</code> permissions, Amazon S3 returns a <code>403 /// Access Denied</code> 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 <code>405 /// Method Not Allowed</code> error. /// </para> /// <important> /// <para> /// To ensure that bucket owners don't inadvertently lock themselves out of their own /// buckets, the root principal in a bucket owner's Amazon Web Services account can perform /// the <code>GetBucketPolicy</code>, <code>PutBucketPolicy</code>, and <code>DeleteBucketPolicy</code> /// API actions, even if their bucket policy explicitly denies the root principal's access. /// Bucket owner root principals can only be blocked from performing these API actions /// by VPC endpoint policies and Amazon Web Services Organizations policies. /// </para> /// </important> /// <para> /// To use this API operation against an access point, provide the alias of the access /// point in place of the bucket name. /// </para> /// /// <para> /// To use this API operation against an Object Lambda access point, provide the alias /// of the Object Lambda access point in place of the bucket name. If the Object Lambda /// access point alias in a request is not valid, the error code <code>InvalidAccessPointAliasError</code> /// is returned. For more information about <code>InvalidAccessPointAliasError</code>, /// see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList">List /// of Error Codes</a>. /// </para> /// /// <para> /// For more information about bucket policies, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html">Using /// Bucket Policies and User Policies</a>. /// </para> /// /// <para> /// The following action is related to <code>GetBucketPolicy</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="bucketName">The bucket name for which to get the bucket policy. To use this API operation against an access point, provide the alias of the access point in place of the bucket name. To use this API operation against an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code <code>InvalidAccessPointAliasError</code> is returned. For more information about <code>InvalidAccessPointAliasError</code>, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList">List of Error Codes</a>.</param> /// /// <returns>The response from the GetBucketPolicy service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketPolicy">REST API Reference for GetBucketPolicy Operation</seealso> GetBucketPolicyResponse GetBucketPolicy(string bucketName); /// <summary> /// 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 <code>GetBucketPolicy</code> permissions on the specified bucket /// and belong to the bucket owner's account in order to use this operation. /// /// /// <para> /// If you don't have <code>GetBucketPolicy</code> permissions, Amazon S3 returns a <code>403 /// Access Denied</code> 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 <code>405 /// Method Not Allowed</code> error. /// </para> /// <important> /// <para> /// To ensure that bucket owners don't inadvertently lock themselves out of their own /// buckets, the root principal in a bucket owner's Amazon Web Services account can perform /// the <code>GetBucketPolicy</code>, <code>PutBucketPolicy</code>, and <code>DeleteBucketPolicy</code> /// API actions, even if their bucket policy explicitly denies the root principal's access. /// Bucket owner root principals can only be blocked from performing these API actions /// by VPC endpoint policies and Amazon Web Services Organizations policies. /// </para> /// </important> /// <para> /// To use this API operation against an access point, provide the alias of the access /// point in place of the bucket name. /// </para> /// /// <para> /// To use this API operation against an Object Lambda access point, provide the alias /// of the Object Lambda access point in place of the bucket name. If the Object Lambda /// access point alias in a request is not valid, the error code <code>InvalidAccessPointAliasError</code> /// is returned. For more information about <code>InvalidAccessPointAliasError</code>, /// see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList">List /// of Error Codes</a>. /// </para> /// /// <para> /// For more information about bucket policies, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html">Using /// Bucket Policies and User Policies</a>. /// </para> /// /// <para> /// The following action is related to <code>GetBucketPolicy</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the GetBucketPolicy service method.</param> /// /// <returns>The response from the GetBucketPolicy service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketPolicy">REST API Reference for GetBucketPolicy Operation</seealso> GetBucketPolicyResponse GetBucketPolicy(GetBucketPolicyRequest request); /// <summary> /// Initiates the asynchronous execution of the GetBucketPolicy operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the GetBucketPolicy operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketPolicy /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketPolicy">REST API Reference for GetBucketPolicy Operation</seealso> IAsyncResult BeginGetBucketPolicy(GetBucketPolicyRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the GetBucketPolicy operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginGetBucketPolicy.</param> /// /// <returns>Returns a GetBucketPolicyResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketPolicy">REST API Reference for GetBucketPolicy Operation</seealso> GetBucketPolicyResponse EndGetBucketPolicy(IAsyncResult asyncResult); #endregion #region GetBucketPolicyStatus /// <summary> /// 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 <code>s3:GetBucketPolicyStatus</code> /// permission. For more information about Amazon S3 permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying /// Permissions in a Policy</a>. /// /// /// <para> /// For more information about when Amazon S3 considers a bucket public, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status">The /// Meaning of "Public"</a>. /// </para> /// /// <para> /// The following operations are related to <code>GetBucketPolicyStatus</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html">Using /// Amazon S3 Block Public Access</a> /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html">GetPublicAccessBlock</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutPublicAccessBlock.html">PutPublicAccessBlock</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeletePublicAccessBlock.html">DeletePublicAccessBlock</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the GetBucketPolicyStatus service method.</param> /// /// <returns>The response from the GetBucketPolicyStatus service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketPolicyStatus">REST API Reference for GetBucketPolicyStatus Operation</seealso> GetBucketPolicyStatusResponse GetBucketPolicyStatus(GetBucketPolicyStatusRequest request); /// <summary> /// Initiates the asynchronous execution of the GetBucketPolicyStatus operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the GetBucketPolicyStatus operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketPolicyStatus /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketPolicyStatus">REST API Reference for GetBucketPolicyStatus Operation</seealso> IAsyncResult BeginGetBucketPolicyStatus(GetBucketPolicyStatusRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the GetBucketPolicyStatus operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginGetBucketPolicyStatus.</param> /// /// <returns>Returns a GetBucketPolicyStatusResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketPolicyStatus">REST API Reference for GetBucketPolicyStatus Operation</seealso> GetBucketPolicyStatusResponse EndGetBucketPolicyStatus(IAsyncResult asyncResult); #endregion #region GetBucketReplication /// <summary> /// Retrieves the replication configuration for the given Amazon S3 bucket. /// </summary> /// <param name="request">Container for the necessary parameters to execute the GetBucketReplication service method.</param> /// /// <returns>The response from the GetBucketReplication service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketReplication">REST API Reference for GetBucketReplication Operation</seealso> GetBucketReplicationResponse GetBucketReplication(GetBucketReplicationRequest request); /// <summary> /// Initiates the asynchronous execution of the GetBucketReplication operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the GetBucketReplication operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketReplication /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketReplication">REST API Reference for GetBucketReplication Operation</seealso> IAsyncResult BeginGetBucketReplication(GetBucketReplicationRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the GetBucketReplication operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginGetBucketReplication.</param> /// /// <returns>Returns a GetBucketReplicationResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketReplication">REST API Reference for GetBucketReplication Operation</seealso> GetBucketReplicationResponse EndGetBucketReplication(IAsyncResult asyncResult); #endregion #region GetBucketRequestPayment /// <summary> /// 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html">Requester /// Pays Buckets</a>. /// /// /// <para> /// The following operations are related to <code>GetBucketRequestPayment</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html">ListObjects</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="bucketName">The name of the bucket for which to get the payment request configuration</param> /// /// <returns>The response from the GetBucketRequestPayment service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketRequestPayment">REST API Reference for GetBucketRequestPayment Operation</seealso> GetBucketRequestPaymentResponse GetBucketRequestPayment(string bucketName); /// <summary> /// 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html">Requester /// Pays Buckets</a>. /// /// /// <para> /// The following operations are related to <code>GetBucketRequestPayment</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html">ListObjects</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the GetBucketRequestPayment service method.</param> /// /// <returns>The response from the GetBucketRequestPayment service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketRequestPayment">REST API Reference for GetBucketRequestPayment Operation</seealso> GetBucketRequestPaymentResponse GetBucketRequestPayment(GetBucketRequestPaymentRequest request); /// <summary> /// Initiates the asynchronous execution of the GetBucketRequestPayment operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the GetBucketRequestPayment operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketRequestPayment /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketRequestPayment">REST API Reference for GetBucketRequestPayment Operation</seealso> IAsyncResult BeginGetBucketRequestPayment(GetBucketRequestPaymentRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the GetBucketRequestPayment operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginGetBucketRequestPayment.</param> /// /// <returns>Returns a GetBucketRequestPaymentResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketRequestPayment">REST API Reference for GetBucketRequestPayment Operation</seealso> GetBucketRequestPaymentResponse EndGetBucketRequestPayment(IAsyncResult asyncResult); #endregion #region GetBucketTagging /// <summary> /// Returns the tag set associated with the bucket. /// /// /// <para> /// To use this operation, you must have permission to perform the <code>s3:GetBucketTagging</code> /// action. By default, the bucket owner has this permission and can grant this permission /// to others. /// </para> /// /// <para> /// <code>GetBucketTagging</code> has the following special error: /// </para> /// <ul> <li> /// <para> /// Error code: <code>NoSuchTagSet</code> /// </para> /// <ul> <li> /// <para> /// Description: There is no tag set associated with the bucket. /// </para> /// </li> </ul> </li> </ul> /// <para> /// The following operations are related to <code>GetBucketTagging</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketTagging.html">PutBucketTagging</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketTagging.html">DeleteBucketTagging</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the GetBucketTagging service method.</param> /// /// <returns>The response from the GetBucketTagging service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketTagging">REST API Reference for GetBucketTagging Operation</seealso> GetBucketTaggingResponse GetBucketTagging(GetBucketTaggingRequest request); /// <summary> /// Initiates the asynchronous execution of the GetBucketTagging operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the GetBucketTagging operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketTagging /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketTagging">REST API Reference for GetBucketTagging Operation</seealso> IAsyncResult BeginGetBucketTagging(GetBucketTaggingRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the GetBucketTagging operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginGetBucketTagging.</param> /// /// <returns>Returns a GetBucketTaggingResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketTagging">REST API Reference for GetBucketTagging Operation</seealso> GetBucketTaggingResponse EndGetBucketTagging(IAsyncResult asyncResult); #endregion #region GetBucketVersioning /// <summary> /// Returns the versioning state of a bucket. /// /// /// <para> /// To retrieve the versioning state of a bucket, you must be the bucket owner. /// </para> /// /// <para> /// This implementation also returns the MFA Delete status of the versioning state. If /// the MFA Delete status is <code>enabled</code>, the bucket owner must use an authentication /// device to change the versioning state of the bucket. /// </para> /// /// <para> /// The following operations are related to <code>GetBucketVersioning</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html">PutObject</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html">DeleteObject</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="bucketName">The name of the bucket for which to get the versioning information.</param> /// /// <returns>The response from the GetBucketVersioning service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketVersioning">REST API Reference for GetBucketVersioning Operation</seealso> GetBucketVersioningResponse GetBucketVersioning(string bucketName); /// <summary> /// Returns the versioning state of a bucket. /// /// /// <para> /// To retrieve the versioning state of a bucket, you must be the bucket owner. /// </para> /// /// <para> /// This implementation also returns the MFA Delete status of the versioning state. If /// the MFA Delete status is <code>enabled</code>, the bucket owner must use an authentication /// device to change the versioning state of the bucket. /// </para> /// /// <para> /// The following operations are related to <code>GetBucketVersioning</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html">PutObject</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html">DeleteObject</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the GetBucketVersioning service method.</param> /// /// <returns>The response from the GetBucketVersioning service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketVersioning">REST API Reference for GetBucketVersioning Operation</seealso> GetBucketVersioningResponse GetBucketVersioning(GetBucketVersioningRequest request); /// <summary> /// Initiates the asynchronous execution of the GetBucketVersioning operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the GetBucketVersioning operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketVersioning /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketVersioning">REST API Reference for GetBucketVersioning Operation</seealso> IAsyncResult BeginGetBucketVersioning(GetBucketVersioningRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the GetBucketVersioning operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginGetBucketVersioning.</param> /// /// <returns>Returns a GetBucketVersioningResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketVersioning">REST API Reference for GetBucketVersioning Operation</seealso> GetBucketVersioningResponse EndGetBucketVersioning(IAsyncResult asyncResult); #endregion #region GetBucketWebsite /// <summary> /// 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html">Hosting /// Websites on Amazon S3</a>. /// /// /// <para> /// This GET action requires the <code>S3:GetBucketWebsite</code> 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 <code>S3:GetBucketWebsite</code> permission. /// </para> /// /// <para> /// The following operations are related to <code>GetBucketWebsite</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketWebsite.html">DeleteBucketWebsite</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketWebsite.html">PutBucketWebsite</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="bucketName">The bucket name for which to get the website configuration.</param> /// /// <returns>The response from the GetBucketWebsite service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketWebsite">REST API Reference for GetBucketWebsite Operation</seealso> GetBucketWebsiteResponse GetBucketWebsite(string bucketName); /// <summary> /// 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html">Hosting /// Websites on Amazon S3</a>. /// /// /// <para> /// This GET action requires the <code>S3:GetBucketWebsite</code> 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 <code>S3:GetBucketWebsite</code> permission. /// </para> /// /// <para> /// The following operations are related to <code>GetBucketWebsite</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketWebsite.html">DeleteBucketWebsite</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketWebsite.html">PutBucketWebsite</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the GetBucketWebsite service method.</param> /// /// <returns>The response from the GetBucketWebsite service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketWebsite">REST API Reference for GetBucketWebsite Operation</seealso> GetBucketWebsiteResponse GetBucketWebsite(GetBucketWebsiteRequest request); /// <summary> /// Initiates the asynchronous execution of the GetBucketWebsite operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the GetBucketWebsite operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketWebsite /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketWebsite">REST API Reference for GetBucketWebsite Operation</seealso> IAsyncResult BeginGetBucketWebsite(GetBucketWebsiteRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the GetBucketWebsite operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginGetBucketWebsite.</param> /// /// <returns>Returns a GetBucketWebsiteResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketWebsite">REST API Reference for GetBucketWebsite Operation</seealso> GetBucketWebsiteResponse EndGetBucketWebsite(IAsyncResult asyncResult); #endregion #region GetCORSConfiguration /// <summary> /// Returns the Cross-Origin Resource Sharing (CORS) configuration information set for /// the bucket. /// /// /// <para> /// To use this operation, you must have permission to perform the <code>s3:GetBucketCORS</code> /// action. By default, the bucket owner has this permission and can grant it to others. /// </para> /// /// <para> /// To use this API operation against an access point, provide the alias of the access /// point in place of the bucket name. /// </para> /// /// <para> /// To use this API operation against an Object Lambda access point, provide the alias /// of the Object Lambda access point in place of the bucket name. If the Object Lambda /// access point alias in a request is not valid, the error code <code>InvalidAccessPointAliasError</code> /// is returned. For more information about <code>InvalidAccessPointAliasError</code>, /// see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList">List /// of Error Codes</a>. /// </para> /// /// <para> /// For more information about CORS, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html"> /// Enabling Cross-Origin Resource Sharing</a>. /// </para> /// /// <para> /// The following operations are related to <code>GetBucketCors</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketCors.html">PutBucketCors</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketCors.html">DeleteBucketCors</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="bucketName">The bucket name for which to get the cors configuration. To use this API operation against an access point, provide the alias of the access point in place of the bucket name. To use this API operation against an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code <code>InvalidAccessPointAliasError</code> is returned. For more information about <code>InvalidAccessPointAliasError</code>, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList">List of Error Codes</a>.</param> /// /// <returns>The response from the GetCORSConfiguration service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketCors">REST API Reference for GetCORSConfiguration Operation</seealso> GetCORSConfigurationResponse GetCORSConfiguration(string bucketName); /// <summary> /// Returns the Cross-Origin Resource Sharing (CORS) configuration information set for /// the bucket. /// /// /// <para> /// To use this operation, you must have permission to perform the <code>s3:GetBucketCORS</code> /// action. By default, the bucket owner has this permission and can grant it to others. /// </para> /// /// <para> /// To use this API operation against an access point, provide the alias of the access /// point in place of the bucket name. /// </para> /// /// <para> /// To use this API operation against an Object Lambda access point, provide the alias /// of the Object Lambda access point in place of the bucket name. If the Object Lambda /// access point alias in a request is not valid, the error code <code>InvalidAccessPointAliasError</code> /// is returned. For more information about <code>InvalidAccessPointAliasError</code>, /// see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList">List /// of Error Codes</a>. /// </para> /// /// <para> /// For more information about CORS, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html"> /// Enabling Cross-Origin Resource Sharing</a>. /// </para> /// /// <para> /// The following operations are related to <code>GetBucketCors</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketCors.html">PutBucketCors</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketCors.html">DeleteBucketCors</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the GetCORSConfiguration service method.</param> /// /// <returns>The response from the GetCORSConfiguration service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketCors">REST API Reference for GetCORSConfiguration Operation</seealso> GetCORSConfigurationResponse GetCORSConfiguration(GetCORSConfigurationRequest request); /// <summary> /// Initiates the asynchronous execution of the GetCORSConfiguration operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the GetCORSConfiguration operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetCORSConfiguration /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketCors">REST API Reference for GetCORSConfiguration Operation</seealso> IAsyncResult BeginGetCORSConfiguration(GetCORSConfigurationRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the GetCORSConfiguration operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginGetCORSConfiguration.</param> /// /// <returns>Returns a GetCORSConfigurationResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketCors">REST API Reference for GetCORSConfiguration Operation</seealso> GetCORSConfigurationResponse EndGetCORSConfiguration(IAsyncResult asyncResult); #endregion #region GetLifecycleConfiguration /// <summary> /// <note> /// <para> /// 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycle.html">GetBucketLifecycle</a>. /// </para> /// </note> /// <para> /// Returns the lifecycle configuration information set on the bucket. For information /// about lifecycle configuration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html">Object /// Lifecycle Management</a>. /// </para> /// /// <para> /// To use this operation, you must have permission to perform the <code>s3:GetLifecycleConfiguration</code> /// action. The bucket owner has this permission, by default. The bucket owner can grant /// this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions /// Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing /// Access Permissions to Your Amazon S3 Resources</a>. /// </para> /// /// <para> /// <code>GetBucketLifecycleConfiguration</code> has the following special error: /// </para> /// <ul> <li> /// <para> /// Error code: <code>NoSuchLifecycleConfiguration</code> /// </para> /// <ul> <li> /// <para> /// Description: The lifecycle configuration does not exist. /// </para> /// </li> <li> /// <para> /// HTTP Status Code: 404 Not Found /// </para> /// </li> <li> /// <para> /// SOAP Fault Code Prefix: Client /// </para> /// </li> </ul> </li> </ul> /// <para> /// The following operations are related to <code>GetBucketLifecycleConfiguration</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycle.html">GetBucketLifecycle</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html">PutBucketLifecycle</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html">DeleteBucketLifecycle</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="bucketName">The name of the bucket for which to get the lifecycle information.</param> /// /// <returns>The response from the GetLifecycleConfiguration service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketLifecycleConfiguration">REST API Reference for GetLifecycleConfiguration Operation</seealso> GetLifecycleConfigurationResponse GetLifecycleConfiguration(string bucketName); /// <summary> /// <note> /// <para> /// 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycle.html">GetBucketLifecycle</a>. /// </para> /// </note> /// <para> /// Returns the lifecycle configuration information set on the bucket. For information /// about lifecycle configuration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html">Object /// Lifecycle Management</a>. /// </para> /// /// <para> /// To use this operation, you must have permission to perform the <code>s3:GetLifecycleConfiguration</code> /// action. The bucket owner has this permission, by default. The bucket owner can grant /// this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions /// Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing /// Access Permissions to Your Amazon S3 Resources</a>. /// </para> /// /// <para> /// <code>GetBucketLifecycleConfiguration</code> has the following special error: /// </para> /// <ul> <li> /// <para> /// Error code: <code>NoSuchLifecycleConfiguration</code> /// </para> /// <ul> <li> /// <para> /// Description: The lifecycle configuration does not exist. /// </para> /// </li> <li> /// <para> /// HTTP Status Code: 404 Not Found /// </para> /// </li> <li> /// <para> /// SOAP Fault Code Prefix: Client /// </para> /// </li> </ul> </li> </ul> /// <para> /// The following operations are related to <code>GetBucketLifecycleConfiguration</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycle.html">GetBucketLifecycle</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html">PutBucketLifecycle</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html">DeleteBucketLifecycle</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the GetLifecycleConfiguration service method.</param> /// /// <returns>The response from the GetLifecycleConfiguration service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketLifecycleConfiguration">REST API Reference for GetLifecycleConfiguration Operation</seealso> GetLifecycleConfigurationResponse GetLifecycleConfiguration(GetLifecycleConfigurationRequest request); /// <summary> /// Initiates the asynchronous execution of the GetLifecycleConfiguration operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the GetLifecycleConfiguration operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetLifecycleConfiguration /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketLifecycleConfiguration">REST API Reference for GetLifecycleConfiguration Operation</seealso> IAsyncResult BeginGetLifecycleConfiguration(GetLifecycleConfigurationRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the GetLifecycleConfiguration operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginGetLifecycleConfiguration.</param> /// /// <returns>Returns a GetLifecycleConfigurationResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketLifecycleConfiguration">REST API Reference for GetLifecycleConfiguration Operation</seealso> GetLifecycleConfigurationResponse EndGetLifecycleConfiguration(IAsyncResult asyncResult); #endregion #region GetObject /// <summary> /// Retrieves objects from Amazon S3. To use <code>GET</code>, you must have <code>READ</code> /// access to the object. If you grant <code>READ</code> access to the anonymous user, /// you can return the object without using an authorization header. /// /// /// <para> /// 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 /// <code>sample.jpg</code>, you can name it <code>photos/2006/February/sample.jpg</code>. /// </para> /// /// <para> /// To get an object from such a logical hierarchy, specify the full key name for the /// object in the <code>GET</code> operation. For a virtual hosted-style request example, /// if you have the object <code>photos/2006/February/sample.jpg</code>, specify the resource /// as <code>/photos/2006/February/sample.jpg</code>. For a path-style request example, /// if you have the object <code>photos/2006/February/sample.jpg</code> in the bucket /// named <code>examplebucket</code>, specify the resource as <code>/examplebucket/photos/2006/February/sample.jpg</code>. /// For more information about request types, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html#VirtualHostingSpecifyBucket">HTTP /// Host Header Bucket Specification</a>. /// </para> /// /// <para> /// For more information about returning the ACL of an object, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html">GetObjectAcl</a>. /// </para> /// /// <para> /// If the object you are retrieving is stored in the S3 Glacier Flexible Retrieval 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html">RestoreObject</a>. /// Otherwise, this action returns an <code>InvalidObjectState</code> error. For information /// about restoring archived objects, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html">Restoring /// Archived Objects</a>. /// </para> /// /// <para> /// Encryption request headers, like <code>x-amz-server-side-encryption</code>, should /// not be sent for GET requests if your object uses server-side encryption with Key Management /// Service (KMS) keys (SSE-KMS), dual-layer server-side encryption with Amazon Web Services /// KMS keys (DSSE-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. /// </para> /// /// <para> /// 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: /// </para> /// <ul> <li> /// <para> /// <code>x-amz-server-side-encryption-customer-algorithm</code> /// </para> /// </li> <li> /// <para> /// <code>x-amz-server-side-encryption-customer-key</code> /// </para> /// </li> <li> /// <para> /// <code>x-amz-server-side-encryption-customer-key-MD5</code> /// </para> /// </li> </ul> /// <para> /// For more information about SSE-C, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side /// Encryption (Using Customer-Provided Encryption Keys)</a>. /// </para> /// /// <para> /// Assuming you have the relevant permission to read object tags, the response also returns /// the <code>x-amz-tagging-count</code> header that provides the count of number of tags /// associated with the object. You can use <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html">GetObjectTagging</a> /// to retrieve the tag set associated with an object. /// </para> /// <dl> <dt>Permissions</dt> <dd> /// <para> /// You need the relevant read object (or version) permission for this operation. For /// more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying /// Permissions in a Policy</a>. If the object that you request doesn’t exist, the error /// that Amazon S3 returns depends on whether you also have the <code>s3:ListBucket</code> /// permission. /// </para> /// /// <para> /// If you have the <code>s3:ListBucket</code> permission on the bucket, Amazon S3 returns /// an HTTP status code 404 (Not Found) error. /// </para> /// /// <para> /// If you don’t have the <code>s3:ListBucket</code> permission, Amazon S3 returns an /// HTTP status code 403 ("access denied") error. /// </para> /// </dd> <dt>Versioning</dt> <dd> /// <para> /// By default, the <code>GET</code> action returns the current version of an object. /// To return a different version, use the <code>versionId</code> subresource. /// </para> /// <note> <ul> <li> /// <para> /// If you supply a <code>versionId</code>, you need the <code>s3:GetObjectVersion</code> /// permission to access a specific version of an object. If you request a specific version, /// you do not need to have the <code>s3:GetObject</code> permission. If you request the /// current version without a specific version ID, only <code>s3:GetObject</code> permission /// is required. <code>s3:GetObjectVersion</code> permission won't be required. /// </para> /// </li> <li> /// <para> /// If the current version of the object is a delete marker, Amazon S3 behaves as if the /// object was deleted and includes <code>x-amz-delete-marker: true</code> in the response. /// </para> /// </li> </ul> </note> /// <para> /// For more information about versioning, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketVersioning.html">PutBucketVersioning</a>. /// /// </para> /// </dd> <dt>Overriding Response Header Values</dt> <dd> /// <para> /// There are times when you want to override certain response header values in a <code>GET</code> /// response. For example, you might override the <code>Content-Disposition</code> response /// header value in your <code>GET</code> request. /// </para> /// /// <para> /// 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 <code>GET</code> response are <code>Content-Type</code>, /// <code>Content-Language</code>, <code>Expires</code>, <code>Cache-Control</code>, <code>Content-Disposition</code>, /// and <code>Content-Encoding</code>. To override these header values in the <code>GET</code> /// response, you use the following request parameters. /// </para> /// <note> /// <para> /// 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. /// </para> /// </note> <ul> <li> /// <para> /// <code>response-content-type</code> /// </para> /// </li> <li> /// <para> /// <code>response-content-language</code> /// </para> /// </li> <li> /// <para> /// <code>response-expires</code> /// </para> /// </li> <li> /// <para> /// <code>response-cache-control</code> /// </para> /// </li> <li> /// <para> /// <code>response-content-disposition</code> /// </para> /// </li> <li> /// <para> /// <code>response-content-encoding</code> /// </para> /// </li> </ul> </dd> <dt>Overriding Response Header Values</dt> <dd> /// <para> /// If both of the <code>If-Match</code> and <code>If-Unmodified-Since</code> headers /// are present in the request as follows: <code>If-Match</code> condition evaluates to /// <code>true</code>, and; <code>If-Unmodified-Since</code> condition evaluates to <code>false</code>; /// then, S3 returns 200 OK and the data requested. /// </para> /// /// <para> /// If both of the <code>If-None-Match</code> and <code>If-Modified-Since</code> headers /// are present in the request as follows:<code> If-None-Match</code> condition evaluates /// to <code>false</code>, and; <code>If-Modified-Since</code> condition evaluates to /// <code>true</code>; then, S3 returns 304 Not Modified response code. /// </para> /// /// <para> /// For more information about conditional requests, see <a href="https://tools.ietf.org/html/rfc7232">RFC /// 7232</a>. /// </para> /// </dd> </dl> /// <para> /// The following operations are related to <code>GetObject</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html">ListBuckets</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html">GetObjectAcl</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="bucketName">The bucket name containing the object. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>. When using an Object Lambda access point the hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-object-lambda.<i>Region</i>.amazonaws.com. When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</param> /// <param name="key">Key of the object to get.</param> /// /// <returns>The response from the GetObject service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObject">REST API Reference for GetObject Operation</seealso> GetObjectResponse GetObject(string bucketName, string key); /// <summary> /// Retrieves objects from Amazon S3. To use <code>GET</code>, you must have <code>READ</code> /// access to the object. If you grant <code>READ</code> access to the anonymous user, /// you can return the object without using an authorization header. /// /// /// <para> /// 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 /// <code>sample.jpg</code>, you can name it <code>photos/2006/February/sample.jpg</code>. /// </para> /// /// <para> /// To get an object from such a logical hierarchy, specify the full key name for the /// object in the <code>GET</code> operation. For a virtual hosted-style request example, /// if you have the object <code>photos/2006/February/sample.jpg</code>, specify the resource /// as <code>/photos/2006/February/sample.jpg</code>. For a path-style request example, /// if you have the object <code>photos/2006/February/sample.jpg</code> in the bucket /// named <code>examplebucket</code>, specify the resource as <code>/examplebucket/photos/2006/February/sample.jpg</code>. /// For more information about request types, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html#VirtualHostingSpecifyBucket">HTTP /// Host Header Bucket Specification</a>. /// </para> /// /// <para> /// For more information about returning the ACL of an object, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html">GetObjectAcl</a>. /// </para> /// /// <para> /// If the object you are retrieving is stored in the S3 Glacier Flexible Retrieval 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html">RestoreObject</a>. /// Otherwise, this action returns an <code>InvalidObjectState</code> error. For information /// about restoring archived objects, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html">Restoring /// Archived Objects</a>. /// </para> /// /// <para> /// Encryption request headers, like <code>x-amz-server-side-encryption</code>, should /// not be sent for GET requests if your object uses server-side encryption with Key Management /// Service (KMS) keys (SSE-KMS), dual-layer server-side encryption with Amazon Web Services /// KMS keys (DSSE-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. /// </para> /// /// <para> /// 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: /// </para> /// <ul> <li> /// <para> /// <code>x-amz-server-side-encryption-customer-algorithm</code> /// </para> /// </li> <li> /// <para> /// <code>x-amz-server-side-encryption-customer-key</code> /// </para> /// </li> <li> /// <para> /// <code>x-amz-server-side-encryption-customer-key-MD5</code> /// </para> /// </li> </ul> /// <para> /// For more information about SSE-C, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side /// Encryption (Using Customer-Provided Encryption Keys)</a>. /// </para> /// /// <para> /// Assuming you have the relevant permission to read object tags, the response also returns /// the <code>x-amz-tagging-count</code> header that provides the count of number of tags /// associated with the object. You can use <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html">GetObjectTagging</a> /// to retrieve the tag set associated with an object. /// </para> /// <dl> <dt>Permissions</dt> <dd> /// <para> /// You need the relevant read object (or version) permission for this operation. For /// more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying /// Permissions in a Policy</a>. If the object that you request doesn’t exist, the error /// that Amazon S3 returns depends on whether you also have the <code>s3:ListBucket</code> /// permission. /// </para> /// /// <para> /// If you have the <code>s3:ListBucket</code> permission on the bucket, Amazon S3 returns /// an HTTP status code 404 (Not Found) error. /// </para> /// /// <para> /// If you don’t have the <code>s3:ListBucket</code> permission, Amazon S3 returns an /// HTTP status code 403 ("access denied") error. /// </para> /// </dd> <dt>Versioning</dt> <dd> /// <para> /// By default, the <code>GET</code> action returns the current version of an object. /// To return a different version, use the <code>versionId</code> subresource. /// </para> /// <note> <ul> <li> /// <para> /// If you supply a <code>versionId</code>, you need the <code>s3:GetObjectVersion</code> /// permission to access a specific version of an object. If you request a specific version, /// you do not need to have the <code>s3:GetObject</code> permission. If you request the /// current version without a specific version ID, only <code>s3:GetObject</code> permission /// is required. <code>s3:GetObjectVersion</code> permission won't be required. /// </para> /// </li> <li> /// <para> /// If the current version of the object is a delete marker, Amazon S3 behaves as if the /// object was deleted and includes <code>x-amz-delete-marker: true</code> in the response. /// </para> /// </li> </ul> </note> /// <para> /// For more information about versioning, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketVersioning.html">PutBucketVersioning</a>. /// /// </para> /// </dd> <dt>Overriding Response Header Values</dt> <dd> /// <para> /// There are times when you want to override certain response header values in a <code>GET</code> /// response. For example, you might override the <code>Content-Disposition</code> response /// header value in your <code>GET</code> request. /// </para> /// /// <para> /// 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 <code>GET</code> response are <code>Content-Type</code>, /// <code>Content-Language</code>, <code>Expires</code>, <code>Cache-Control</code>, <code>Content-Disposition</code>, /// and <code>Content-Encoding</code>. To override these header values in the <code>GET</code> /// response, you use the following request parameters. /// </para> /// <note> /// <para> /// 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. /// </para> /// </note> <ul> <li> /// <para> /// <code>response-content-type</code> /// </para> /// </li> <li> /// <para> /// <code>response-content-language</code> /// </para> /// </li> <li> /// <para> /// <code>response-expires</code> /// </para> /// </li> <li> /// <para> /// <code>response-cache-control</code> /// </para> /// </li> <li> /// <para> /// <code>response-content-disposition</code> /// </para> /// </li> <li> /// <para> /// <code>response-content-encoding</code> /// </para> /// </li> </ul> </dd> <dt>Overriding Response Header Values</dt> <dd> /// <para> /// If both of the <code>If-Match</code> and <code>If-Unmodified-Since</code> headers /// are present in the request as follows: <code>If-Match</code> condition evaluates to /// <code>true</code>, and; <code>If-Unmodified-Since</code> condition evaluates to <code>false</code>; /// then, S3 returns 200 OK and the data requested. /// </para> /// /// <para> /// If both of the <code>If-None-Match</code> and <code>If-Modified-Since</code> headers /// are present in the request as follows:<code> If-None-Match</code> condition evaluates /// to <code>false</code>, and; <code>If-Modified-Since</code> condition evaluates to /// <code>true</code>; then, S3 returns 304 Not Modified response code. /// </para> /// /// <para> /// For more information about conditional requests, see <a href="https://tools.ietf.org/html/rfc7232">RFC /// 7232</a>. /// </para> /// </dd> </dl> /// <para> /// The following operations are related to <code>GetObject</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html">ListBuckets</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html">GetObjectAcl</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="bucketName">The bucket name containing the object. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>. When using an Object Lambda access point the hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-object-lambda.<i>Region</i>.amazonaws.com. When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</param> /// <param name="key">Key of the object to get.</param> /// <param name="versionId">VersionId used to reference a specific version of the object.</param> /// /// <returns>The response from the GetObject service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObject">REST API Reference for GetObject Operation</seealso> GetObjectResponse GetObject(string bucketName, string key, string versionId); /// <summary> /// Retrieves objects from Amazon S3. To use <code>GET</code>, you must have <code>READ</code> /// access to the object. If you grant <code>READ</code> access to the anonymous user, /// you can return the object without using an authorization header. /// /// /// <para> /// 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 /// <code>sample.jpg</code>, you can name it <code>photos/2006/February/sample.jpg</code>. /// </para> /// /// <para> /// To get an object from such a logical hierarchy, specify the full key name for the /// object in the <code>GET</code> operation. For a virtual hosted-style request example, /// if you have the object <code>photos/2006/February/sample.jpg</code>, specify the resource /// as <code>/photos/2006/February/sample.jpg</code>. For a path-style request example, /// if you have the object <code>photos/2006/February/sample.jpg</code> in the bucket /// named <code>examplebucket</code>, specify the resource as <code>/examplebucket/photos/2006/February/sample.jpg</code>. /// For more information about request types, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html#VirtualHostingSpecifyBucket">HTTP /// Host Header Bucket Specification</a>. /// </para> /// /// <para> /// For more information about returning the ACL of an object, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html">GetObjectAcl</a>. /// </para> /// /// <para> /// If the object you are retrieving is stored in the S3 Glacier Flexible Retrieval 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html">RestoreObject</a>. /// Otherwise, this action returns an <code>InvalidObjectState</code> error. For information /// about restoring archived objects, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html">Restoring /// Archived Objects</a>. /// </para> /// /// <para> /// Encryption request headers, like <code>x-amz-server-side-encryption</code>, should /// not be sent for GET requests if your object uses server-side encryption with Key Management /// Service (KMS) keys (SSE-KMS), dual-layer server-side encryption with Amazon Web Services /// KMS keys (DSSE-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. /// </para> /// /// <para> /// 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: /// </para> /// <ul> <li> /// <para> /// <code>x-amz-server-side-encryption-customer-algorithm</code> /// </para> /// </li> <li> /// <para> /// <code>x-amz-server-side-encryption-customer-key</code> /// </para> /// </li> <li> /// <para> /// <code>x-amz-server-side-encryption-customer-key-MD5</code> /// </para> /// </li> </ul> /// <para> /// For more information about SSE-C, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side /// Encryption (Using Customer-Provided Encryption Keys)</a>. /// </para> /// /// <para> /// Assuming you have the relevant permission to read object tags, the response also returns /// the <code>x-amz-tagging-count</code> header that provides the count of number of tags /// associated with the object. You can use <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html">GetObjectTagging</a> /// to retrieve the tag set associated with an object. /// </para> /// <dl> <dt>Permissions</dt> <dd> /// <para> /// You need the relevant read object (or version) permission for this operation. For /// more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying /// Permissions in a Policy</a>. If the object that you request doesn’t exist, the error /// that Amazon S3 returns depends on whether you also have the <code>s3:ListBucket</code> /// permission. /// </para> /// /// <para> /// If you have the <code>s3:ListBucket</code> permission on the bucket, Amazon S3 returns /// an HTTP status code 404 (Not Found) error. /// </para> /// /// <para> /// If you don’t have the <code>s3:ListBucket</code> permission, Amazon S3 returns an /// HTTP status code 403 ("access denied") error. /// </para> /// </dd> <dt>Versioning</dt> <dd> /// <para> /// By default, the <code>GET</code> action returns the current version of an object. /// To return a different version, use the <code>versionId</code> subresource. /// </para> /// <note> <ul> <li> /// <para> /// If you supply a <code>versionId</code>, you need the <code>s3:GetObjectVersion</code> /// permission to access a specific version of an object. If you request a specific version, /// you do not need to have the <code>s3:GetObject</code> permission. If you request the /// current version without a specific version ID, only <code>s3:GetObject</code> permission /// is required. <code>s3:GetObjectVersion</code> permission won't be required. /// </para> /// </li> <li> /// <para> /// If the current version of the object is a delete marker, Amazon S3 behaves as if the /// object was deleted and includes <code>x-amz-delete-marker: true</code> in the response. /// </para> /// </li> </ul> </note> /// <para> /// For more information about versioning, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketVersioning.html">PutBucketVersioning</a>. /// /// </para> /// </dd> <dt>Overriding Response Header Values</dt> <dd> /// <para> /// There are times when you want to override certain response header values in a <code>GET</code> /// response. For example, you might override the <code>Content-Disposition</code> response /// header value in your <code>GET</code> request. /// </para> /// /// <para> /// 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 <code>GET</code> response are <code>Content-Type</code>, /// <code>Content-Language</code>, <code>Expires</code>, <code>Cache-Control</code>, <code>Content-Disposition</code>, /// and <code>Content-Encoding</code>. To override these header values in the <code>GET</code> /// response, you use the following request parameters. /// </para> /// <note> /// <para> /// 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. /// </para> /// </note> <ul> <li> /// <para> /// <code>response-content-type</code> /// </para> /// </li> <li> /// <para> /// <code>response-content-language</code> /// </para> /// </li> <li> /// <para> /// <code>response-expires</code> /// </para> /// </li> <li> /// <para> /// <code>response-cache-control</code> /// </para> /// </li> <li> /// <para> /// <code>response-content-disposition</code> /// </para> /// </li> <li> /// <para> /// <code>response-content-encoding</code> /// </para> /// </li> </ul> </dd> <dt>Overriding Response Header Values</dt> <dd> /// <para> /// If both of the <code>If-Match</code> and <code>If-Unmodified-Since</code> headers /// are present in the request as follows: <code>If-Match</code> condition evaluates to /// <code>true</code>, and; <code>If-Unmodified-Since</code> condition evaluates to <code>false</code>; /// then, S3 returns 200 OK and the data requested. /// </para> /// /// <para> /// If both of the <code>If-None-Match</code> and <code>If-Modified-Since</code> headers /// are present in the request as follows:<code> If-None-Match</code> condition evaluates /// to <code>false</code>, and; <code>If-Modified-Since</code> condition evaluates to /// <code>true</code>; then, S3 returns 304 Not Modified response code. /// </para> /// /// <para> /// For more information about conditional requests, see <a href="https://tools.ietf.org/html/rfc7232">RFC /// 7232</a>. /// </para> /// </dd> </dl> /// <para> /// The following operations are related to <code>GetObject</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html">ListBuckets</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html">GetObjectAcl</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the GetObject service method.</param> /// /// <returns>The response from the GetObject service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObject">REST API Reference for GetObject Operation</seealso> GetObjectResponse GetObject(GetObjectRequest request); /// <summary> /// Initiates the asynchronous execution of the GetObject operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the GetObject operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetObject /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObject">REST API Reference for GetObject Operation</seealso> IAsyncResult BeginGetObject(GetObjectRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the GetObject operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginGetObject.</param> /// /// <returns>Returns a GetObjectResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObject">REST API Reference for GetObject Operation</seealso> GetObjectResponse EndGetObject(IAsyncResult asyncResult); #endregion #region GetObjectAttributes /// <summary> /// 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 <code>GetObjectAttributes</code>, /// you must have READ access to the object. /// /// /// <para> /// <code>GetObjectAttributes</code> combines the functionality of <code>HeadObject</code> /// and <code>ListParts</code>. All of the data returned with each of those individual /// calls can be returned with a single call to <code>GetObjectAttributes</code>. /// </para> /// /// <para> /// 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: /// </para> /// <ul> <li> /// <para> /// <code>x-amz-server-side-encryption-customer-algorithm</code> /// </para> /// </li> <li> /// <para> /// <code>x-amz-server-side-encryption-customer-key</code> /// </para> /// </li> <li> /// <para> /// <code>x-amz-server-side-encryption-customer-key-MD5</code> /// </para> /// </li> </ul> /// <para> /// For more information about SSE-C, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side /// Encryption (Using Customer-Provided Encryption Keys)</a> in the <i>Amazon S3 User /// Guide</i>. /// </para> /// <note> <ul> <li> /// <para> /// Encryption request headers, such as <code>x-amz-server-side-encryption</code>, 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 keys (SSE-S3). If your object does /// use these types of keys, you'll get an HTTP <code>400 Bad Request</code> error. /// </para> /// </li> <li> /// <para> /// The last modified property in this case is the creation date of the object. /// </para> /// </li> </ul> </note> /// <para> /// Consider the following when using request headers: /// </para> /// <ul> <li> /// <para> /// If both of the <code>If-Match</code> and <code>If-Unmodified-Since</code> headers /// are present in the request as follows, then Amazon S3 returns the HTTP status code /// <code>200 OK</code> and the data requested: /// </para> /// <ul> <li> /// <para> /// <code>If-Match</code> condition evaluates to <code>true</code>. /// </para> /// </li> <li> /// <para> /// <code>If-Unmodified-Since</code> condition evaluates to <code>false</code>. /// </para> /// </li> </ul> </li> <li> /// <para> /// If both of the <code>If-None-Match</code> and <code>If-Modified-Since</code> headers /// are present in the request as follows, then Amazon S3 returns the HTTP status code /// <code>304 Not Modified</code>: /// </para> /// <ul> <li> /// <para> /// <code>If-None-Match</code> condition evaluates to <code>false</code>. /// </para> /// </li> <li> /// <para> /// <code>If-Modified-Since</code> condition evaluates to <code>true</code>. /// </para> /// </li> </ul> </li> </ul> /// <para> /// For more information about conditional requests, see <a href="https://tools.ietf.org/html/rfc7232">RFC /// 7232</a>. /// </para> /// <dl> <dt>Permissions</dt> <dd> /// <para> /// 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 <code>s3:GetObjectVersion</code> /// and <code>s3:GetObjectVersionAttributes</code> permissions for this operation. If /// the bucket is not versioned, you need the <code>s3:GetObject</code> and <code>s3:GetObjectAttributes</code> /// permissions. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying /// Permissions in a Policy</a> in the <i>Amazon S3 User Guide</i>. If the object that /// you request does not exist, the error Amazon S3 returns depends on whether you also /// have the <code>s3:ListBucket</code> permission. /// </para> /// <ul> <li> /// <para> /// If you have the <code>s3:ListBucket</code> permission on the bucket, Amazon S3 returns /// an HTTP status code <code>404 Not Found</code> ("no such key") error. /// </para> /// </li> <li> /// <para> /// If you don't have the <code>s3:ListBucket</code> permission, Amazon S3 returns an /// HTTP status code <code>403 Forbidden</code> ("access denied") error. /// </para> /// </li> </ul> </dd> </dl> /// <para> /// The following actions are related to <code>GetObjectAttributes</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html">GetObjectAcl</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectLegalHold.html">GetObjectLegalHold</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectLockConfiguration.html">GetObjectLockConfiguration</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectRetention.html">GetObjectRetention</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html">GetObjectTagging</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadObject.html">HeadObject</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html">ListParts</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the GetObjectAttributes service method.</param> /// /// <returns>The response from the GetObjectAttributes service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectAttributes">REST API Reference for GetObjectAttributes Operation</seealso> GetObjectAttributesResponse GetObjectAttributes(GetObjectAttributesRequest request); /// <summary> /// Initiates the asynchronous execution of the GetObjectAttributes operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the GetObjectAttributes operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetObjectAttributes /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectAttributes">REST API Reference for GetObjectAttributes Operation</seealso> IAsyncResult BeginGetObjectAttributes(GetObjectAttributesRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the GetObjectAttributes operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginGetObjectAttributes.</param> /// /// <returns>Returns a GetObjectAttributesResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectAttributes">REST API Reference for GetObjectAttributes Operation</seealso> GetObjectAttributesResponse EndGetObjectAttributes(IAsyncResult asyncResult); #endregion #region GetObjectLegalHold /// <summary> /// Gets an object's current legal hold status. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Locking /// Objects</a>. /// /// /// <para> /// This action is not supported by Amazon S3 on Outposts. /// </para> /// /// <para> /// The following action is related to <code>GetObjectLegalHold</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html">GetObjectAttributes</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the GetObjectLegalHold service method.</param> /// /// <returns>The response from the GetObjectLegalHold service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectLegalHold">REST API Reference for GetObjectLegalHold Operation</seealso> GetObjectLegalHoldResponse GetObjectLegalHold(GetObjectLegalHoldRequest request); /// <summary> /// Initiates the asynchronous execution of the GetObjectLegalHold operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the GetObjectLegalHold operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetObjectLegalHold /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectLegalHold">REST API Reference for GetObjectLegalHold Operation</seealso> IAsyncResult BeginGetObjectLegalHold(GetObjectLegalHoldRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the GetObjectLegalHold operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginGetObjectLegalHold.</param> /// /// <returns>Returns a GetObjectLegalHoldResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectLegalHold">REST API Reference for GetObjectLegalHold Operation</seealso> GetObjectLegalHoldResponse EndGetObjectLegalHold(IAsyncResult asyncResult); #endregion #region GetObjectLockConfiguration /// <summary> /// 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Locking /// Objects</a>. /// /// /// <para> /// The following action is related to <code>GetObjectLockConfiguration</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html">GetObjectAttributes</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the GetObjectLockConfiguration service method.</param> /// /// <returns>The response from the GetObjectLockConfiguration service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectLockConfiguration">REST API Reference for GetObjectLockConfiguration Operation</seealso> GetObjectLockConfigurationResponse GetObjectLockConfiguration(GetObjectLockConfigurationRequest request); /// <summary> /// Initiates the asynchronous execution of the GetObjectLockConfiguration operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the GetObjectLockConfiguration operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetObjectLockConfiguration /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectLockConfiguration">REST API Reference for GetObjectLockConfiguration Operation</seealso> IAsyncResult BeginGetObjectLockConfiguration(GetObjectLockConfigurationRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the GetObjectLockConfiguration operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginGetObjectLockConfiguration.</param> /// /// <returns>Returns a GetObjectLockConfigurationResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectLockConfiguration">REST API Reference for GetObjectLockConfiguration Operation</seealso> GetObjectLockConfigurationResponse EndGetObjectLockConfiguration(IAsyncResult asyncResult); #endregion #region GetObjectMetadata /// <summary> /// The <code>HEAD</code> 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 <code>HEAD</code>, you must have READ access to the object. /// /// /// <para> /// A <code>HEAD</code> request has the same options as a <code>GET</code> action on an /// object. The response is identical to the <code>GET</code> response except that there /// is no response body. Because of this, if the <code>HEAD</code> request generates an /// error, it returns a generic <code>400 Bad Request</code>, <code>403 Forbidden</code> /// or <code>404 Not Found</code> code. It is not possible to retrieve the exact exception /// beyond these error codes. /// </para> /// /// <para> /// 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: /// </para> /// <ul> <li> /// <para> /// <code>x-amz-server-side-encryption-customer-algorithm</code> /// </para> /// </li> <li> /// <para> /// <code>x-amz-server-side-encryption-customer-key</code> /// </para> /// </li> <li> /// <para> /// <code>x-amz-server-side-encryption-customer-key-MD5</code> /// </para> /// </li> </ul> /// <para> /// For more information about SSE-C, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side /// Encryption (Using Customer-Provided Encryption Keys)</a>. /// </para> /// <note> <ul> <li> /// <para> /// Encryption request headers, like <code>x-amz-server-side-encryption</code>, should /// not be sent for <code>GET</code> requests if your object uses server-side encryption /// with Key Management Service (KMS) keys (SSE-KMS), dual-layer server-side encryption /// with Amazon Web Services KMS keys (DSSE-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. /// </para> /// </li> <li> /// <para> /// The last modified property in this case is the creation date of the object. /// </para> /// </li> </ul> </note> /// <para> /// Request headers are limited to 8 KB in size. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTCommonRequestHeaders.html">Common /// Request Headers</a>. /// </para> /// /// <para> /// Consider the following when using request headers: /// </para> /// <ul> <li> /// <para> /// Consideration 1 – If both of the <code>If-Match</code> and <code>If-Unmodified-Since</code> /// headers are present in the request as follows: /// </para> /// <ul> <li> /// <para> /// <code>If-Match</code> condition evaluates to <code>true</code>, and; /// </para> /// </li> <li> /// <para> /// <code>If-Unmodified-Since</code> condition evaluates to <code>false</code>; /// </para> /// </li> </ul> /// <para> /// Then Amazon S3 returns <code>200 OK</code> and the data requested. /// </para> /// </li> <li> /// <para> /// Consideration 2 – If both of the <code>If-None-Match</code> and <code>If-Modified-Since</code> /// headers are present in the request as follows: /// </para> /// <ul> <li> /// <para> /// <code>If-None-Match</code> condition evaluates to <code>false</code>, and; /// </para> /// </li> <li> /// <para> /// <code>If-Modified-Since</code> condition evaluates to <code>true</code>; /// </para> /// </li> </ul> /// <para> /// Then Amazon S3 returns the <code>304 Not Modified</code> response code. /// </para> /// </li> </ul> /// <para> /// For more information about conditional requests, see <a href="https://tools.ietf.org/html/rfc7232">RFC /// 7232</a>. /// </para> /// <dl> <dt>Permissions</dt> <dd> /// <para> /// You need the relevant read object (or version) permission for this operation. For /// more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/list_amazons3.html">Actions, /// resources, and condition keys for Amazon S3</a>. If the object you request doesn't /// exist, the error that Amazon S3 returns depends on whether you also have the s3:ListBucket /// permission. /// </para> /// <ul> <li> /// <para> /// If you have the <code>s3:ListBucket</code> permission on the bucket, Amazon S3 returns /// an HTTP status code 404 error. /// </para> /// </li> <li> /// <para> /// If you don’t have the <code>s3:ListBucket</code> permission, Amazon S3 returns an /// HTTP status code 403 error. /// </para> /// </li> </ul> </dd> </dl> /// <para> /// The following actions are related to <code>HeadObject</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html">GetObjectAttributes</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="bucketName">The name of the bucket containing the object. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>. When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</param> /// <param name="key">The object key.</param> /// /// <returns>The response from the GetObjectMetadata service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/HeadObject">REST API Reference for GetObjectMetadata Operation</seealso> GetObjectMetadataResponse GetObjectMetadata(string bucketName, string key); /// <summary> /// The <code>HEAD</code> 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 <code>HEAD</code>, you must have READ access to the object. /// /// /// <para> /// A <code>HEAD</code> request has the same options as a <code>GET</code> action on an /// object. The response is identical to the <code>GET</code> response except that there /// is no response body. Because of this, if the <code>HEAD</code> request generates an /// error, it returns a generic <code>400 Bad Request</code>, <code>403 Forbidden</code> /// or <code>404 Not Found</code> code. It is not possible to retrieve the exact exception /// beyond these error codes. /// </para> /// /// <para> /// 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: /// </para> /// <ul> <li> /// <para> /// <code>x-amz-server-side-encryption-customer-algorithm</code> /// </para> /// </li> <li> /// <para> /// <code>x-amz-server-side-encryption-customer-key</code> /// </para> /// </li> <li> /// <para> /// <code>x-amz-server-side-encryption-customer-key-MD5</code> /// </para> /// </li> </ul> /// <para> /// For more information about SSE-C, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side /// Encryption (Using Customer-Provided Encryption Keys)</a>. /// </para> /// <note> <ul> <li> /// <para> /// Encryption request headers, like <code>x-amz-server-side-encryption</code>, should /// not be sent for <code>GET</code> requests if your object uses server-side encryption /// with Key Management Service (KMS) keys (SSE-KMS), dual-layer server-side encryption /// with Amazon Web Services KMS keys (DSSE-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. /// </para> /// </li> <li> /// <para> /// The last modified property in this case is the creation date of the object. /// </para> /// </li> </ul> </note> /// <para> /// Request headers are limited to 8 KB in size. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTCommonRequestHeaders.html">Common /// Request Headers</a>. /// </para> /// /// <para> /// Consider the following when using request headers: /// </para> /// <ul> <li> /// <para> /// Consideration 1 – If both of the <code>If-Match</code> and <code>If-Unmodified-Since</code> /// headers are present in the request as follows: /// </para> /// <ul> <li> /// <para> /// <code>If-Match</code> condition evaluates to <code>true</code>, and; /// </para> /// </li> <li> /// <para> /// <code>If-Unmodified-Since</code> condition evaluates to <code>false</code>; /// </para> /// </li> </ul> /// <para> /// Then Amazon S3 returns <code>200 OK</code> and the data requested. /// </para> /// </li> <li> /// <para> /// Consideration 2 – If both of the <code>If-None-Match</code> and <code>If-Modified-Since</code> /// headers are present in the request as follows: /// </para> /// <ul> <li> /// <para> /// <code>If-None-Match</code> condition evaluates to <code>false</code>, and; /// </para> /// </li> <li> /// <para> /// <code>If-Modified-Since</code> condition evaluates to <code>true</code>; /// </para> /// </li> </ul> /// <para> /// Then Amazon S3 returns the <code>304 Not Modified</code> response code. /// </para> /// </li> </ul> /// <para> /// For more information about conditional requests, see <a href="https://tools.ietf.org/html/rfc7232">RFC /// 7232</a>. /// </para> /// <dl> <dt>Permissions</dt> <dd> /// <para> /// You need the relevant read object (or version) permission for this operation. For /// more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/list_amazons3.html">Actions, /// resources, and condition keys for Amazon S3</a>. If the object you request doesn't /// exist, the error that Amazon S3 returns depends on whether you also have the s3:ListBucket /// permission. /// </para> /// <ul> <li> /// <para> /// If you have the <code>s3:ListBucket</code> permission on the bucket, Amazon S3 returns /// an HTTP status code 404 error. /// </para> /// </li> <li> /// <para> /// If you don’t have the <code>s3:ListBucket</code> permission, Amazon S3 returns an /// HTTP status code 403 error. /// </para> /// </li> </ul> </dd> </dl> /// <para> /// The following actions are related to <code>HeadObject</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html">GetObjectAttributes</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="bucketName">The name of the bucket containing the object. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>. When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</param> /// <param name="key">The object key.</param> /// <param name="versionId">VersionId used to reference a specific version of the object.</param> /// /// <returns>The response from the GetObjectMetadata service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/HeadObject">REST API Reference for GetObjectMetadata Operation</seealso> GetObjectMetadataResponse GetObjectMetadata(string bucketName, string key, string versionId); /// <summary> /// The <code>HEAD</code> 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 <code>HEAD</code>, you must have READ access to the object. /// /// /// <para> /// A <code>HEAD</code> request has the same options as a <code>GET</code> action on an /// object. The response is identical to the <code>GET</code> response except that there /// is no response body. Because of this, if the <code>HEAD</code> request generates an /// error, it returns a generic <code>400 Bad Request</code>, <code>403 Forbidden</code> /// or <code>404 Not Found</code> code. It is not possible to retrieve the exact exception /// beyond these error codes. /// </para> /// /// <para> /// 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: /// </para> /// <ul> <li> /// <para> /// <code>x-amz-server-side-encryption-customer-algorithm</code> /// </para> /// </li> <li> /// <para> /// <code>x-amz-server-side-encryption-customer-key</code> /// </para> /// </li> <li> /// <para> /// <code>x-amz-server-side-encryption-customer-key-MD5</code> /// </para> /// </li> </ul> /// <para> /// For more information about SSE-C, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side /// Encryption (Using Customer-Provided Encryption Keys)</a>. /// </para> /// <note> <ul> <li> /// <para> /// Encryption request headers, like <code>x-amz-server-side-encryption</code>, should /// not be sent for <code>GET</code> requests if your object uses server-side encryption /// with Key Management Service (KMS) keys (SSE-KMS), dual-layer server-side encryption /// with Amazon Web Services KMS keys (DSSE-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. /// </para> /// </li> <li> /// <para> /// The last modified property in this case is the creation date of the object. /// </para> /// </li> </ul> </note> /// <para> /// Request headers are limited to 8 KB in size. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTCommonRequestHeaders.html">Common /// Request Headers</a>. /// </para> /// /// <para> /// Consider the following when using request headers: /// </para> /// <ul> <li> /// <para> /// Consideration 1 – If both of the <code>If-Match</code> and <code>If-Unmodified-Since</code> /// headers are present in the request as follows: /// </para> /// <ul> <li> /// <para> /// <code>If-Match</code> condition evaluates to <code>true</code>, and; /// </para> /// </li> <li> /// <para> /// <code>If-Unmodified-Since</code> condition evaluates to <code>false</code>; /// </para> /// </li> </ul> /// <para> /// Then Amazon S3 returns <code>200 OK</code> and the data requested. /// </para> /// </li> <li> /// <para> /// Consideration 2 – If both of the <code>If-None-Match</code> and <code>If-Modified-Since</code> /// headers are present in the request as follows: /// </para> /// <ul> <li> /// <para> /// <code>If-None-Match</code> condition evaluates to <code>false</code>, and; /// </para> /// </li> <li> /// <para> /// <code>If-Modified-Since</code> condition evaluates to <code>true</code>; /// </para> /// </li> </ul> /// <para> /// Then Amazon S3 returns the <code>304 Not Modified</code> response code. /// </para> /// </li> </ul> /// <para> /// For more information about conditional requests, see <a href="https://tools.ietf.org/html/rfc7232">RFC /// 7232</a>. /// </para> /// <dl> <dt>Permissions</dt> <dd> /// <para> /// You need the relevant read object (or version) permission for this operation. For /// more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/list_amazons3.html">Actions, /// resources, and condition keys for Amazon S3</a>. If the object you request doesn't /// exist, the error that Amazon S3 returns depends on whether you also have the s3:ListBucket /// permission. /// </para> /// <ul> <li> /// <para> /// If you have the <code>s3:ListBucket</code> permission on the bucket, Amazon S3 returns /// an HTTP status code 404 error. /// </para> /// </li> <li> /// <para> /// If you don’t have the <code>s3:ListBucket</code> permission, Amazon S3 returns an /// HTTP status code 403 error. /// </para> /// </li> </ul> </dd> </dl> /// <para> /// The following actions are related to <code>HeadObject</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html">GetObjectAttributes</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the GetObjectMetadata service method.</param> /// /// <returns>The response from the GetObjectMetadata service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/HeadObject">REST API Reference for GetObjectMetadata Operation</seealso> GetObjectMetadataResponse GetObjectMetadata(GetObjectMetadataRequest request); /// <summary> /// Initiates the asynchronous execution of the GetObjectMetadata operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the GetObjectMetadata operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetObjectMetadata /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/HeadObject">REST API Reference for GetObjectMetadata Operation</seealso> IAsyncResult BeginGetObjectMetadata(GetObjectMetadataRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the GetObjectMetadata operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginGetObjectMetadata.</param> /// /// <returns>Returns a GetObjectMetadataResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/HeadObject">REST API Reference for GetObjectMetadata Operation</seealso> GetObjectMetadataResponse EndGetObjectMetadata(IAsyncResult asyncResult); #endregion #region GetObjectRetention /// <summary> /// Retrieves an object's retention settings. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Locking /// Objects</a>. /// /// /// <para> /// This action is not supported by Amazon S3 on Outposts. /// </para> /// /// <para> /// The following action is related to <code>GetObjectRetention</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html">GetObjectAttributes</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the GetObjectRetention service method.</param> /// /// <returns>The response from the GetObjectRetention service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectRetention">REST API Reference for GetObjectRetention Operation</seealso> GetObjectRetentionResponse GetObjectRetention(GetObjectRetentionRequest request); /// <summary> /// Initiates the asynchronous execution of the GetObjectRetention operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the GetObjectRetention operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetObjectRetention /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectRetention">REST API Reference for GetObjectRetention Operation</seealso> IAsyncResult BeginGetObjectRetention(GetObjectRetentionRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the GetObjectRetention operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginGetObjectRetention.</param> /// /// <returns>Returns a GetObjectRetentionResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectRetention">REST API Reference for GetObjectRetention Operation</seealso> GetObjectRetentionResponse EndGetObjectRetention(IAsyncResult asyncResult); #endregion #region GetObjectTagging /// <summary> /// Returns the tag-set of an object. You send the GET request against the tagging subresource /// associated with the object. /// /// /// <para> /// To use this operation, you must have permission to perform the <code>s3:GetObjectTagging</code> /// 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 <code>s3:GetObjectVersionTagging</code> action. /// </para> /// /// <para> /// By default, the bucket owner has this permission and can grant this permission to /// others. /// </para> /// /// <para> /// For information about the Amazon S3 object tagging feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html">Object /// Tagging</a>. /// </para> /// /// <para> /// The following actions are related to <code>GetObjectTagging</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObjectTagging.html">DeleteObjectTagging</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html">GetObjectAttributes</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObjectTagging.html">PutObjectTagging</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the GetObjectTagging service method.</param> /// /// <returns>The response from the GetObjectTagging service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectTagging">REST API Reference for GetObjectTagging Operation</seealso> GetObjectTaggingResponse GetObjectTagging(GetObjectTaggingRequest request); /// <summary> /// Initiates the asynchronous execution of the GetObjectTagging operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the GetObjectTagging operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetObjectTagging /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectTagging">REST API Reference for GetObjectTagging Operation</seealso> IAsyncResult BeginGetObjectTagging(GetObjectTaggingRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the GetObjectTagging operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginGetObjectTagging.</param> /// /// <returns>Returns a GetObjectTaggingResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectTagging">REST API Reference for GetObjectTagging Operation</seealso> GetObjectTaggingResponse EndGetObjectTagging(IAsyncResult asyncResult); #endregion #region GetObjectTorrent /// <summary> /// Returns torrent files from a bucket. BitTorrent can save you bandwidth when you're /// distributing large files. /// /// <note> /// <para> /// 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. /// </para> /// </note> /// <para> /// To use GET, you must have READ access to the object. /// </para> /// /// <para> /// This action is not supported by Amazon S3 on Outposts. /// </para> /// /// <para> /// The following action is related to <code>GetObjectTorrent</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="bucketName">The name of the bucket containing the object for which to get the torrent files.</param> /// <param name="key">The object key for which to get the information.</param> /// /// <returns>The response from the GetObjectTorrent service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectTorrent">REST API Reference for GetObjectTorrent Operation</seealso> GetObjectTorrentResponse GetObjectTorrent(string bucketName, string key); /// <summary> /// Returns torrent files from a bucket. BitTorrent can save you bandwidth when you're /// distributing large files. /// /// <note> /// <para> /// 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. /// </para> /// </note> /// <para> /// To use GET, you must have READ access to the object. /// </para> /// /// <para> /// This action is not supported by Amazon S3 on Outposts. /// </para> /// /// <para> /// The following action is related to <code>GetObjectTorrent</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the GetObjectTorrent service method.</param> /// /// <returns>The response from the GetObjectTorrent service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectTorrent">REST API Reference for GetObjectTorrent Operation</seealso> GetObjectTorrentResponse GetObjectTorrent(GetObjectTorrentRequest request); /// <summary> /// Initiates the asynchronous execution of the GetObjectTorrent operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the GetObjectTorrent operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetObjectTorrent /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectTorrent">REST API Reference for GetObjectTorrent Operation</seealso> IAsyncResult BeginGetObjectTorrent(GetObjectTorrentRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the GetObjectTorrent operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginGetObjectTorrent.</param> /// /// <returns>Returns a GetObjectTorrentResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectTorrent">REST API Reference for GetObjectTorrent Operation</seealso> GetObjectTorrentResponse EndGetObjectTorrent(IAsyncResult asyncResult); #endregion #region GetPublicAccessBlock /// <summary> /// Retrieves the <code>PublicAccessBlock</code> configuration for an Amazon S3 bucket. /// To use this operation, you must have the <code>s3:GetBucketPublicAccessBlock</code> /// permission. For more information about Amazon S3 permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying /// Permissions in a Policy</a>. /// /// <important> /// <para> /// When Amazon S3 evaluates the <code>PublicAccessBlock</code> configuration for a bucket /// or an object, it checks the <code>PublicAccessBlock</code> configuration for both /// the bucket (or the bucket that contains the object) and the bucket owner's account. /// If the <code>PublicAccessBlock</code> settings are different between the bucket and /// the account, Amazon S3 uses the most restrictive combination of the bucket-level and /// account-level settings. /// </para> /// </important> /// <para> /// For more information about when Amazon S3 considers a bucket or an object public, /// see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status">The /// Meaning of "Public"</a>. /// </para> /// /// <para> /// The following operations are related to <code>GetPublicAccessBlock</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html">Using /// Amazon S3 Block Public Access</a> /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutPublicAccessBlock.html">PutPublicAccessBlock</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html">GetPublicAccessBlock</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeletePublicAccessBlock.html">DeletePublicAccessBlock</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the GetPublicAccessBlock service method.</param> /// /// <returns>The response from the GetPublicAccessBlock service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetPublicAccessBlock">REST API Reference for GetPublicAccessBlock Operation</seealso> GetPublicAccessBlockResponse GetPublicAccessBlock(GetPublicAccessBlockRequest request); /// <summary> /// Initiates the asynchronous execution of the GetPublicAccessBlock operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the GetPublicAccessBlock operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetPublicAccessBlock /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetPublicAccessBlock">REST API Reference for GetPublicAccessBlock Operation</seealso> IAsyncResult BeginGetPublicAccessBlock(GetPublicAccessBlockRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the GetPublicAccessBlock operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginGetPublicAccessBlock.</param> /// /// <returns>Returns a GetPublicAccessBlockResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetPublicAccessBlock">REST API Reference for GetPublicAccessBlock Operation</seealso> GetPublicAccessBlockResponse EndGetPublicAccessBlock(IAsyncResult asyncResult); #endregion #region InitiateMultipartUpload /// <summary> /// 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html">UploadPart</a>). /// You also include this upload ID in the final request to either complete or abort the /// multipart upload request. /// /// /// <para> /// For more information about multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html">Multipart /// Upload Overview</a>. /// </para> /// /// <para> /// 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config">Aborting /// Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration</a>. /// </para> /// /// <para> /// For information about the permissions required to use the multipart upload API, see /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html">Multipart /// Upload and Permissions</a>. /// </para> /// /// <para> /// 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 <a /// href="https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html">Authenticating /// Requests (Amazon Web Services Signature Version 4)</a>. /// </para> /// <note> /// <para> /// 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. /// </para> /// </note> /// <para> /// 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. Amazon /// S3 automatically encrypts all new objects that are uploaded to an S3 bucket. When /// doing a multipart upload, if you don't specify encryption information in your request, /// the encryption setting of the uploaded parts is set to the default encryption configuration /// of the destination bucket. By default, all buckets have a base level of encryption /// configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3). /// If the destination bucket has a default encryption configuration that uses server-side /// encryption with an Key Management Service (KMS) key (SSE-KMS), or a customer-provided /// encryption key (SSE-C), Amazon S3 uses the corresponding KMS key, or a customer-provided /// key to encrypt the uploaded parts. When you perform a CreateMultipartUpload operation, /// if you want to use a different type of encryption setting for the uploaded parts, /// you can request that Amazon S3 encrypts the object with a KMS key, an Amazon S3 managed /// key, or a customer-provided key. If the encryption setting in your request is different /// from the default encryption configuration of the destination bucket, the encryption /// setting in your request takes precedence. If you choose to provide your own encryption /// key, the request headers you provide in <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html">UploadPart</a> /// and <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html">UploadPartCopy</a> /// requests must match the headers you used in the request to initiate the upload by /// using <code>CreateMultipartUpload</code>. You can request that Amazon S3 save the /// uploaded parts encrypted with server-side encryption with an Amazon S3 managed key /// (SSE-S3), an Key Management Service (KMS) key (SSE-KMS), or a customer-provided encryption /// key (SSE-C). /// </para> /// /// <para> /// To perform a multipart upload with encryption by using an Amazon Web Services KMS /// key, the requester must have permission to the <code>kms:Decrypt</code> and <code>kms:GenerateDataKey*</code> /// 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/mpuoverview.html#mpuAndPermissions">Multipart /// upload API and permissions</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html">Protecting /// data using server-side encryption with Amazon Web Services KMS</a> in the <i>Amazon /// S3 User Guide</i>. /// </para> /// /// <para> /// 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. /// </para> /// /// <para> /// For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html">Protecting /// Data Using Server-Side Encryption</a>. /// </para> /// <dl> <dt>Access Permissions</dt> <dd> /// <para> /// 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: /// </para> /// <ul> <li> /// <para> /// Specify a canned ACL with the <code>x-amz-acl</code> request header. For more information, /// see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL">Canned /// ACL</a>. /// </para> /// </li> <li> /// <para> /// Specify access permissions explicitly with the <code>x-amz-grant-read</code>, <code>x-amz-grant-read-acp</code>, /// <code>x-amz-grant-write-acp</code>, and <code>x-amz-grant-full-control</code> headers. /// These parameters map to the set of permissions that Amazon S3 supports in an ACL. /// For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html">Access /// Control List (ACL) Overview</a>. /// </para> /// </li> </ul> /// <para> /// You can use either a canned ACL or specify access permissions explicitly. You cannot /// do both. /// </para> /// </dd> <dt>Server-Side- Encryption-Specific Request Headers</dt> <dd> /// <para> /// Amazon S3 encrypts data by using server-side encryption with an Amazon S3 managed /// key (SSE-S3) by default. 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. You can request that Amazon S3 encrypts data at rest by using /// server-side encryption with other key options. The option you use depends on whether /// you want to use KMS keys (SSE-KMS) or provide your own encryption keys (SSE-C). /// </para> /// <ul> <li> /// <para> /// Use KMS keys (SSE-KMS) that include the Amazon Web Services managed key (<code>aws/s3</code>) /// and KMS customer managed keys stored in Key Management Service (KMS) – If you want /// Amazon Web Services to manage the keys used to encrypt data, specify the following /// headers in the request. /// </para> /// <ul> <li> /// <para> /// <code>x-amz-server-side-encryption</code> /// </para> /// </li> <li> /// <para> /// <code>x-amz-server-side-encryption-aws-kms-key-id</code> /// </para> /// </li> <li> /// <para> /// <code>x-amz-server-side-encryption-context</code> /// </para> /// </li> </ul> <note> /// <para> /// If you specify <code>x-amz-server-side-encryption:aws:kms</code>, but don't provide /// <code>x-amz-server-side-encryption-aws-kms-key-id</code>, Amazon S3 uses the Amazon /// Web Services managed key (<code>aws/s3</code> key) in KMS to protect the data. /// </para> /// </note> <important> /// <para> /// All <code>GET</code> and <code>PUT</code> requests for an object protected by KMS /// fail if you don't make them by using Secure Sockets Layer (SSL), Transport Layer Security /// (TLS), or Signature Version 4. /// </para> /// </important> /// <para> /// For more information about server-side encryption with KMS keys (SSE-KMS), see <a /// href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html">Protecting /// Data Using Server-Side Encryption with KMS keys</a>. /// </para> /// </li> <li> /// <para> /// Use customer-provided encryption keys (SSE-C) – If you want to manage your own encryption /// keys, provide all the following headers in the request. /// </para> /// <ul> <li> /// <para> /// <code>x-amz-server-side-encryption-customer-algorithm</code> /// </para> /// </li> <li> /// <para> /// <code>x-amz-server-side-encryption-customer-key</code> /// </para> /// </li> <li> /// <para> /// <code>x-amz-server-side-encryption-customer-key-MD5</code> /// </para> /// </li> </ul> /// <para> /// For more information about server-side encryption with customer-provided encryption /// keys (SSE-C), see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerSideEncryptionCustomerKeys.html"> /// Protecting data using server-side encryption with customer-provided encryption keys /// (SSE-C)</a>. /// </para> /// </li> </ul> </dd> <dt>Access-Control-List (ACL)-Specific Request Headers</dt> <dd> /// /// <para> /// 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html">Using /// ACLs</a>. With this operation, you can grant access permissions using one of the following /// two methods: /// </para> /// <ul> <li> /// <para> /// Specify a canned ACL (<code>x-amz-acl</code>) — Amazon S3 supports a set of predefined /// ACLs, known as <i>canned ACLs</i>. Each canned ACL has a predefined set of grantees /// and permissions. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL">Canned /// ACL</a>. /// </para> /// </li> <li> /// <para> /// 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html">Access /// Control List (ACL) Overview</a>. In the header, you specify a list of grantees who /// get the specific permission. To grant permissions explicitly, use: /// </para> /// <ul> <li> /// <para> /// <code>x-amz-grant-read</code> /// </para> /// </li> <li> /// <para> /// <code>x-amz-grant-write</code> /// </para> /// </li> <li> /// <para> /// <code>x-amz-grant-read-acp</code> /// </para> /// </li> <li> /// <para> /// <code>x-amz-grant-write-acp</code> /// </para> /// </li> <li> /// <para> /// <code>x-amz-grant-full-control</code> /// </para> /// </li> </ul> /// <para> /// You specify each grantee as a type=value pair, where the type is one of the following: /// </para> /// <ul> <li> /// <para> /// <code>id</code> – if the value specified is the canonical user ID of an Amazon Web /// Services account /// </para> /// </li> <li> /// <para> /// <code>uri</code> – if you are granting permissions to a predefined group /// </para> /// </li> <li> /// <para> /// <code>emailAddress</code> – if the value specified is the email address of an Amazon /// Web Services account /// </para> /// <note> /// <para> /// Using email addresses to specify a grantee is only supported in the following Amazon /// Web Services Regions: /// </para> /// <ul> <li> /// <para> /// US East (N. Virginia) /// </para> /// </li> <li> /// <para> /// US West (N. California) /// </para> /// </li> <li> /// <para> /// US West (Oregon) /// </para> /// </li> <li> /// <para> /// Asia Pacific (Singapore) /// </para> /// </li> <li> /// <para> /// Asia Pacific (Sydney) /// </para> /// </li> <li> /// <para> /// Asia Pacific (Tokyo) /// </para> /// </li> <li> /// <para> /// Europe (Ireland) /// </para> /// </li> <li> /// <para> /// South America (São Paulo) /// </para> /// </li> </ul> /// <para> /// For a list of all the Amazon S3 supported Regions and endpoints, see <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region">Regions /// and Endpoints</a> in the Amazon Web Services General Reference. /// </para> /// </note> </li> </ul> /// <para> /// For example, the following <code>x-amz-grant-read</code> header grants the Amazon /// Web Services accounts identified by account IDs permissions to read object data and /// its metadata: /// </para> /// /// <para> /// <code>x-amz-grant-read: id="11112222333", id="444455556666" </code> /// </para> /// </li> </ul> </dd> </dl> /// <para> /// The following operations are related to <code>CreateMultipartUpload</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html">UploadPart</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html">CompleteMultipartUpload</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html">AbortMultipartUpload</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html">ListParts</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html">ListMultipartUploads</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="bucketName">The name of the bucket to which to initiate the upload When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>. When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</param> /// <param name="key">Object key for which the multipart upload is to be initiated.</param> /// /// <returns>The response from the InitiateMultipartUpload service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/CreateMultipartUpload">REST API Reference for InitiateMultipartUpload Operation</seealso> InitiateMultipartUploadResponse InitiateMultipartUpload(string bucketName, string key); /// <summary> /// 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html">UploadPart</a>). /// You also include this upload ID in the final request to either complete or abort the /// multipart upload request. /// /// /// <para> /// For more information about multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html">Multipart /// Upload Overview</a>. /// </para> /// /// <para> /// 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config">Aborting /// Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration</a>. /// </para> /// /// <para> /// For information about the permissions required to use the multipart upload API, see /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html">Multipart /// Upload and Permissions</a>. /// </para> /// /// <para> /// 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 <a /// href="https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html">Authenticating /// Requests (Amazon Web Services Signature Version 4)</a>. /// </para> /// <note> /// <para> /// 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. /// </para> /// </note> /// <para> /// 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. Amazon /// S3 automatically encrypts all new objects that are uploaded to an S3 bucket. When /// doing a multipart upload, if you don't specify encryption information in your request, /// the encryption setting of the uploaded parts is set to the default encryption configuration /// of the destination bucket. By default, all buckets have a base level of encryption /// configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3). /// If the destination bucket has a default encryption configuration that uses server-side /// encryption with an Key Management Service (KMS) key (SSE-KMS), or a customer-provided /// encryption key (SSE-C), Amazon S3 uses the corresponding KMS key, or a customer-provided /// key to encrypt the uploaded parts. When you perform a CreateMultipartUpload operation, /// if you want to use a different type of encryption setting for the uploaded parts, /// you can request that Amazon S3 encrypts the object with a KMS key, an Amazon S3 managed /// key, or a customer-provided key. If the encryption setting in your request is different /// from the default encryption configuration of the destination bucket, the encryption /// setting in your request takes precedence. If you choose to provide your own encryption /// key, the request headers you provide in <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html">UploadPart</a> /// and <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html">UploadPartCopy</a> /// requests must match the headers you used in the request to initiate the upload by /// using <code>CreateMultipartUpload</code>. You can request that Amazon S3 save the /// uploaded parts encrypted with server-side encryption with an Amazon S3 managed key /// (SSE-S3), an Key Management Service (KMS) key (SSE-KMS), or a customer-provided encryption /// key (SSE-C). /// </para> /// /// <para> /// To perform a multipart upload with encryption by using an Amazon Web Services KMS /// key, the requester must have permission to the <code>kms:Decrypt</code> and <code>kms:GenerateDataKey*</code> /// 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/mpuoverview.html#mpuAndPermissions">Multipart /// upload API and permissions</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html">Protecting /// data using server-side encryption with Amazon Web Services KMS</a> in the <i>Amazon /// S3 User Guide</i>. /// </para> /// /// <para> /// 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. /// </para> /// /// <para> /// For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html">Protecting /// Data Using Server-Side Encryption</a>. /// </para> /// <dl> <dt>Access Permissions</dt> <dd> /// <para> /// 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: /// </para> /// <ul> <li> /// <para> /// Specify a canned ACL with the <code>x-amz-acl</code> request header. For more information, /// see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL">Canned /// ACL</a>. /// </para> /// </li> <li> /// <para> /// Specify access permissions explicitly with the <code>x-amz-grant-read</code>, <code>x-amz-grant-read-acp</code>, /// <code>x-amz-grant-write-acp</code>, and <code>x-amz-grant-full-control</code> headers. /// These parameters map to the set of permissions that Amazon S3 supports in an ACL. /// For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html">Access /// Control List (ACL) Overview</a>. /// </para> /// </li> </ul> /// <para> /// You can use either a canned ACL or specify access permissions explicitly. You cannot /// do both. /// </para> /// </dd> <dt>Server-Side- Encryption-Specific Request Headers</dt> <dd> /// <para> /// Amazon S3 encrypts data by using server-side encryption with an Amazon S3 managed /// key (SSE-S3) by default. 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. You can request that Amazon S3 encrypts data at rest by using /// server-side encryption with other key options. The option you use depends on whether /// you want to use KMS keys (SSE-KMS) or provide your own encryption keys (SSE-C). /// </para> /// <ul> <li> /// <para> /// Use KMS keys (SSE-KMS) that include the Amazon Web Services managed key (<code>aws/s3</code>) /// and KMS customer managed keys stored in Key Management Service (KMS) – If you want /// Amazon Web Services to manage the keys used to encrypt data, specify the following /// headers in the request. /// </para> /// <ul> <li> /// <para> /// <code>x-amz-server-side-encryption</code> /// </para> /// </li> <li> /// <para> /// <code>x-amz-server-side-encryption-aws-kms-key-id</code> /// </para> /// </li> <li> /// <para> /// <code>x-amz-server-side-encryption-context</code> /// </para> /// </li> </ul> <note> /// <para> /// If you specify <code>x-amz-server-side-encryption:aws:kms</code>, but don't provide /// <code>x-amz-server-side-encryption-aws-kms-key-id</code>, Amazon S3 uses the Amazon /// Web Services managed key (<code>aws/s3</code> key) in KMS to protect the data. /// </para> /// </note> <important> /// <para> /// All <code>GET</code> and <code>PUT</code> requests for an object protected by KMS /// fail if you don't make them by using Secure Sockets Layer (SSL), Transport Layer Security /// (TLS), or Signature Version 4. /// </para> /// </important> /// <para> /// For more information about server-side encryption with KMS keys (SSE-KMS), see <a /// href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html">Protecting /// Data Using Server-Side Encryption with KMS keys</a>. /// </para> /// </li> <li> /// <para> /// Use customer-provided encryption keys (SSE-C) – If you want to manage your own encryption /// keys, provide all the following headers in the request. /// </para> /// <ul> <li> /// <para> /// <code>x-amz-server-side-encryption-customer-algorithm</code> /// </para> /// </li> <li> /// <para> /// <code>x-amz-server-side-encryption-customer-key</code> /// </para> /// </li> <li> /// <para> /// <code>x-amz-server-side-encryption-customer-key-MD5</code> /// </para> /// </li> </ul> /// <para> /// For more information about server-side encryption with customer-provided encryption /// keys (SSE-C), see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerSideEncryptionCustomerKeys.html"> /// Protecting data using server-side encryption with customer-provided encryption keys /// (SSE-C)</a>. /// </para> /// </li> </ul> </dd> <dt>Access-Control-List (ACL)-Specific Request Headers</dt> <dd> /// /// <para> /// 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html">Using /// ACLs</a>. With this operation, you can grant access permissions using one of the following /// two methods: /// </para> /// <ul> <li> /// <para> /// Specify a canned ACL (<code>x-amz-acl</code>) — Amazon S3 supports a set of predefined /// ACLs, known as <i>canned ACLs</i>. Each canned ACL has a predefined set of grantees /// and permissions. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL">Canned /// ACL</a>. /// </para> /// </li> <li> /// <para> /// 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html">Access /// Control List (ACL) Overview</a>. In the header, you specify a list of grantees who /// get the specific permission. To grant permissions explicitly, use: /// </para> /// <ul> <li> /// <para> /// <code>x-amz-grant-read</code> /// </para> /// </li> <li> /// <para> /// <code>x-amz-grant-write</code> /// </para> /// </li> <li> /// <para> /// <code>x-amz-grant-read-acp</code> /// </para> /// </li> <li> /// <para> /// <code>x-amz-grant-write-acp</code> /// </para> /// </li> <li> /// <para> /// <code>x-amz-grant-full-control</code> /// </para> /// </li> </ul> /// <para> /// You specify each grantee as a type=value pair, where the type is one of the following: /// </para> /// <ul> <li> /// <para> /// <code>id</code> – if the value specified is the canonical user ID of an Amazon Web /// Services account /// </para> /// </li> <li> /// <para> /// <code>uri</code> – if you are granting permissions to a predefined group /// </para> /// </li> <li> /// <para> /// <code>emailAddress</code> – if the value specified is the email address of an Amazon /// Web Services account /// </para> /// <note> /// <para> /// Using email addresses to specify a grantee is only supported in the following Amazon /// Web Services Regions: /// </para> /// <ul> <li> /// <para> /// US East (N. Virginia) /// </para> /// </li> <li> /// <para> /// US West (N. California) /// </para> /// </li> <li> /// <para> /// US West (Oregon) /// </para> /// </li> <li> /// <para> /// Asia Pacific (Singapore) /// </para> /// </li> <li> /// <para> /// Asia Pacific (Sydney) /// </para> /// </li> <li> /// <para> /// Asia Pacific (Tokyo) /// </para> /// </li> <li> /// <para> /// Europe (Ireland) /// </para> /// </li> <li> /// <para> /// South America (São Paulo) /// </para> /// </li> </ul> /// <para> /// For a list of all the Amazon S3 supported Regions and endpoints, see <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region">Regions /// and Endpoints</a> in the Amazon Web Services General Reference. /// </para> /// </note> </li> </ul> /// <para> /// For example, the following <code>x-amz-grant-read</code> header grants the Amazon /// Web Services accounts identified by account IDs permissions to read object data and /// its metadata: /// </para> /// /// <para> /// <code>x-amz-grant-read: id="11112222333", id="444455556666" </code> /// </para> /// </li> </ul> </dd> </dl> /// <para> /// The following operations are related to <code>CreateMultipartUpload</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html">UploadPart</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html">CompleteMultipartUpload</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html">AbortMultipartUpload</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html">ListParts</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html">ListMultipartUploads</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the InitiateMultipartUpload service method.</param> /// /// <returns>The response from the InitiateMultipartUpload service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/CreateMultipartUpload">REST API Reference for InitiateMultipartUpload Operation</seealso> InitiateMultipartUploadResponse InitiateMultipartUpload(InitiateMultipartUploadRequest request); /// <summary> /// Initiates the asynchronous execution of the InitiateMultipartUpload operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the InitiateMultipartUpload operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndInitiateMultipartUpload /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/CreateMultipartUpload">REST API Reference for InitiateMultipartUpload Operation</seealso> IAsyncResult BeginInitiateMultipartUpload(InitiateMultipartUploadRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the InitiateMultipartUpload operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginInitiateMultipartUpload.</param> /// /// <returns>Returns a InitiateMultipartUploadResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/CreateMultipartUpload">REST API Reference for InitiateMultipartUpload Operation</seealso> InitiateMultipartUploadResponse EndInitiateMultipartUpload(IAsyncResult asyncResult); #endregion #region ListBucketAnalyticsConfigurations /// <summary> /// Lists the analytics configurations for the bucket. You can have up to 1,000 analytics /// configurations per bucket. /// /// /// <para> /// This action supports list pagination and does not return more than 100 configurations /// at a time. You should always check the <code>IsTruncated</code> element in the response. /// If there are no more configurations to list, <code>IsTruncated</code> is set to false. /// If there are more configurations to list, <code>IsTruncated</code> is set to true, /// and there will be a value in <code>NextContinuationToken</code>. You use the <code>NextContinuationToken</code> /// value to continue the pagination of the list by passing the value in continuation-token /// in the request to <code>GET</code> the next page. /// </para> /// /// <para> /// To use this operation, you must have permissions to perform the <code>s3:GetAnalyticsConfiguration</code> /// action. The bucket owner has this permission by default. The bucket owner can grant /// this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions /// Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing /// Access Permissions to Your Amazon S3 Resources</a>. /// </para> /// /// <para> /// For information about Amazon S3 analytics feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html">Amazon /// S3 Analytics – Storage Class Analysis</a>. /// </para> /// /// <para> /// The following operations are related to <code>ListBucketAnalyticsConfigurations</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAnalyticsConfiguration.html">GetBucketAnalyticsConfiguration</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketAnalyticsConfiguration.html">DeleteBucketAnalyticsConfiguration</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAnalyticsConfiguration.html">PutBucketAnalyticsConfiguration</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the ListBucketAnalyticsConfigurations service method.</param> /// /// <returns>The response from the ListBucketAnalyticsConfigurations service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListBucketAnalyticsConfigurations">REST API Reference for ListBucketAnalyticsConfigurations Operation</seealso> ListBucketAnalyticsConfigurationsResponse ListBucketAnalyticsConfigurations(ListBucketAnalyticsConfigurationsRequest request); /// <summary> /// Initiates the asynchronous execution of the ListBucketAnalyticsConfigurations operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the ListBucketAnalyticsConfigurations operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListBucketAnalyticsConfigurations /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListBucketAnalyticsConfigurations">REST API Reference for ListBucketAnalyticsConfigurations Operation</seealso> IAsyncResult BeginListBucketAnalyticsConfigurations(ListBucketAnalyticsConfigurationsRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the ListBucketAnalyticsConfigurations operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginListBucketAnalyticsConfigurations.</param> /// /// <returns>Returns a ListBucketAnalyticsConfigurationsResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListBucketAnalyticsConfigurations">REST API Reference for ListBucketAnalyticsConfigurations Operation</seealso> ListBucketAnalyticsConfigurationsResponse EndListBucketAnalyticsConfigurations(IAsyncResult asyncResult); #endregion #region ListBucketIntelligentTieringConfigurations /// <summary> /// Lists the S3 Intelligent-Tiering configuration from the specified bucket. /// /// /// <para> /// 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. /// </para> /// /// <para> /// 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. /// </para> /// /// <para> /// For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access">Storage /// class for automatically optimizing frequently and infrequently accessed objects</a>. /// </para> /// /// <para> /// Operations related to <code>ListBucketIntelligentTieringConfigurations</code> include: /// /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketIntelligentTieringConfiguration.html">DeleteBucketIntelligentTieringConfiguration</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketIntelligentTieringConfiguration.html">PutBucketIntelligentTieringConfiguration</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketIntelligentTieringConfiguration.html">GetBucketIntelligentTieringConfiguration</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the ListBucketIntelligentTieringConfigurations service method.</param> /// /// <returns>The response from the ListBucketIntelligentTieringConfigurations service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListBucketIntelligentTieringConfigurations">REST API Reference for ListBucketIntelligentTieringConfigurations Operation</seealso> ListBucketIntelligentTieringConfigurationsResponse ListBucketIntelligentTieringConfigurations(ListBucketIntelligentTieringConfigurationsRequest request); /// <summary> /// Initiates the asynchronous execution of the ListBucketIntelligentTieringConfigurations operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the ListBucketIntelligentTieringConfigurations operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListBucketIntelligentTieringConfigurations /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListBucketIntelligentTieringConfigurations">REST API Reference for ListBucketIntelligentTieringConfigurations Operation</seealso> IAsyncResult BeginListBucketIntelligentTieringConfigurations(ListBucketIntelligentTieringConfigurationsRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the ListBucketIntelligentTieringConfigurations operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginListBucketIntelligentTieringConfigurations.</param> /// /// <returns>Returns a ListBucketIntelligentTieringConfigurationsResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListBucketIntelligentTieringConfigurations">REST API Reference for ListBucketIntelligentTieringConfigurations Operation</seealso> ListBucketIntelligentTieringConfigurationsResponse EndListBucketIntelligentTieringConfigurations(IAsyncResult asyncResult); #endregion #region ListBucketInventoryConfigurations /// <summary> /// Returns a list of inventory configurations for the bucket. You can have up to 1,000 /// analytics configurations per bucket. /// /// /// <para> /// This action supports list pagination and does not return more than 100 configurations /// at a time. Always check the <code>IsTruncated</code> element in the response. If there /// are no more configurations to list, <code>IsTruncated</code> is set to false. If there /// are more configurations to list, <code>IsTruncated</code> is set to true, and there /// is a value in <code>NextContinuationToken</code>. You use the <code>NextContinuationToken</code> /// value to continue the pagination of the list by passing the value in continuation-token /// in the request to <code>GET</code> the next page. /// </para> /// /// <para> /// To use this operation, you must have permissions to perform the <code>s3:GetInventoryConfiguration</code> /// action. The bucket owner has this permission by default. The bucket owner can grant /// this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions /// Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing /// Access Permissions to Your Amazon S3 Resources</a>. /// </para> /// /// <para> /// For information about the Amazon S3 inventory feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html">Amazon /// S3 Inventory</a> /// </para> /// /// <para> /// The following operations are related to <code>ListBucketInventoryConfigurations</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketInventoryConfiguration.html">GetBucketInventoryConfiguration</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketInventoryConfiguration.html">DeleteBucketInventoryConfiguration</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketInventoryConfiguration.html">PutBucketInventoryConfiguration</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the ListBucketInventoryConfigurations service method.</param> /// /// <returns>The response from the ListBucketInventoryConfigurations service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListBucketInventoryConfigurations">REST API Reference for ListBucketInventoryConfigurations Operation</seealso> ListBucketInventoryConfigurationsResponse ListBucketInventoryConfigurations(ListBucketInventoryConfigurationsRequest request); /// <summary> /// Initiates the asynchronous execution of the ListBucketInventoryConfigurations operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the ListBucketInventoryConfigurations operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListBucketInventoryConfigurations /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListBucketInventoryConfigurations">REST API Reference for ListBucketInventoryConfigurations Operation</seealso> IAsyncResult BeginListBucketInventoryConfigurations(ListBucketInventoryConfigurationsRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the ListBucketInventoryConfigurations operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginListBucketInventoryConfigurations.</param> /// /// <returns>Returns a ListBucketInventoryConfigurationsResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListBucketInventoryConfigurations">REST API Reference for ListBucketInventoryConfigurations Operation</seealso> ListBucketInventoryConfigurationsResponse EndListBucketInventoryConfigurations(IAsyncResult asyncResult); #endregion #region ListBucketMetricsConfigurations /// <summary> /// 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. /// /// /// <para> /// This action supports list pagination and does not return more than 100 configurations /// at a time. Always check the <code>IsTruncated</code> element in the response. If there /// are no more configurations to list, <code>IsTruncated</code> is set to false. If there /// are more configurations to list, <code>IsTruncated</code> is set to true, and there /// is a value in <code>NextContinuationToken</code>. You use the <code>NextContinuationToken</code> /// value to continue the pagination of the list by passing the value in <code>continuation-token</code> /// in the request to <code>GET</code> the next page. /// </para> /// /// <para> /// To use this operation, you must have permissions to perform the <code>s3:GetMetricsConfiguration</code> /// action. The bucket owner has this permission by default. The bucket owner can grant /// this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions /// Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing /// Access Permissions to Your Amazon S3 Resources</a>. /// </para> /// /// <para> /// For more information about metrics configurations and CloudWatch request metrics, /// see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html">Monitoring /// Metrics with Amazon CloudWatch</a>. /// </para> /// /// <para> /// The following operations are related to <code>ListBucketMetricsConfigurations</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html">PutBucketMetricsConfiguration</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketMetricsConfiguration.html">GetBucketMetricsConfiguration</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetricsConfiguration.html">DeleteBucketMetricsConfiguration</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the ListBucketMetricsConfigurations service method.</param> /// /// <returns>The response from the ListBucketMetricsConfigurations service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListBucketMetricsConfigurations">REST API Reference for ListBucketMetricsConfigurations Operation</seealso> ListBucketMetricsConfigurationsResponse ListBucketMetricsConfigurations(ListBucketMetricsConfigurationsRequest request); /// <summary> /// Initiates the asynchronous execution of the ListBucketMetricsConfigurations operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the ListBucketMetricsConfigurations operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListBucketMetricsConfigurations /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListBucketMetricsConfigurations">REST API Reference for ListBucketMetricsConfigurations Operation</seealso> IAsyncResult BeginListBucketMetricsConfigurations(ListBucketMetricsConfigurationsRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the ListBucketMetricsConfigurations operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginListBucketMetricsConfigurations.</param> /// /// <returns>Returns a ListBucketMetricsConfigurationsResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListBucketMetricsConfigurations">REST API Reference for ListBucketMetricsConfigurations Operation</seealso> ListBucketMetricsConfigurationsResponse EndListBucketMetricsConfigurations(IAsyncResult asyncResult); #endregion #region ListBuckets /// <summary> /// Returns a list of all buckets owned by the authenticated sender of the request. To /// use this operation, you must have the <code>s3:ListAllMyBuckets</code> permission. /// /// /// /// <para> /// For information about Amazon S3 buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html">Creating, /// configuring, and working with Amazon S3 buckets</a>. /// </para> /// </summary> /// /// <returns>The response from the ListBuckets service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListBuckets">REST API Reference for ListBuckets Operation</seealso> ListBucketsResponse ListBuckets(); /// <summary> /// Returns a list of all buckets owned by the authenticated sender of the request. To /// use this operation, you must have the <code>s3:ListAllMyBuckets</code> permission. /// /// /// /// <para> /// For information about Amazon S3 buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html">Creating, /// configuring, and working with Amazon S3 buckets</a>. /// </para> /// </summary> /// <param name="request">Container for the necessary parameters to execute the ListBuckets service method.</param> /// /// <returns>The response from the ListBuckets service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListBuckets">REST API Reference for ListBuckets Operation</seealso> ListBucketsResponse ListBuckets(ListBucketsRequest request); /// <summary> /// Initiates the asynchronous execution of the ListBuckets operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the ListBuckets operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListBuckets /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListBuckets">REST API Reference for ListBuckets Operation</seealso> IAsyncResult BeginListBuckets(ListBucketsRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the ListBuckets operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginListBuckets.</param> /// /// <returns>Returns a ListBucketsResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListBuckets">REST API Reference for ListBuckets Operation</seealso> ListBucketsResponse EndListBuckets(IAsyncResult asyncResult); #endregion #region ListMultipartUploads /// <summary> /// 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. /// /// /// <para> /// 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 <code>max-uploads</code> parameter in the response. If additional multipart uploads /// satisfy the list criteria, the response will contain an <code>IsTruncated</code> element /// with the value true. To list the additional multipart uploads, use the <code>key-marker</code> /// and <code>upload-id-marker</code> request parameters. /// </para> /// /// <para> /// 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. /// </para> /// /// <para> /// For more information on multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html">Uploading /// Objects Using Multipart Upload</a>. /// </para> /// /// <para> /// For information on permissions required to use the multipart upload API, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html">Multipart /// Upload and Permissions</a>. /// </para> /// /// <para> /// The following operations are related to <code>ListMultipartUploads</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html">CreateMultipartUpload</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html">UploadPart</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html">CompleteMultipartUpload</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html">ListParts</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html">AbortMultipartUpload</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="bucketName">The name of the bucket to which the multipart upload was initiated. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>. When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</param> /// /// <returns>The response from the ListMultipartUploads service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListMultipartUploads">REST API Reference for ListMultipartUploads Operation</seealso> ListMultipartUploadsResponse ListMultipartUploads(string bucketName); /// <summary> /// 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. /// /// /// <para> /// 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 <code>max-uploads</code> parameter in the response. If additional multipart uploads /// satisfy the list criteria, the response will contain an <code>IsTruncated</code> element /// with the value true. To list the additional multipart uploads, use the <code>key-marker</code> /// and <code>upload-id-marker</code> request parameters. /// </para> /// /// <para> /// 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. /// </para> /// /// <para> /// For more information on multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html">Uploading /// Objects Using Multipart Upload</a>. /// </para> /// /// <para> /// For information on permissions required to use the multipart upload API, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html">Multipart /// Upload and Permissions</a>. /// </para> /// /// <para> /// The following operations are related to <code>ListMultipartUploads</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html">CreateMultipartUpload</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html">UploadPart</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html">CompleteMultipartUpload</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html">ListParts</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html">AbortMultipartUpload</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="bucketName">The name of the bucket to which the multipart upload was initiated. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>. When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</param> /// <param name="prefix">Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using <code>prefix</code> to make groups in the same way that you'd use a folder in a file system.)</param> /// /// <returns>The response from the ListMultipartUploads service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListMultipartUploads">REST API Reference for ListMultipartUploads Operation</seealso> ListMultipartUploadsResponse ListMultipartUploads(string bucketName, string prefix); /// <summary> /// 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. /// /// /// <para> /// 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 <code>max-uploads</code> parameter in the response. If additional multipart uploads /// satisfy the list criteria, the response will contain an <code>IsTruncated</code> element /// with the value true. To list the additional multipart uploads, use the <code>key-marker</code> /// and <code>upload-id-marker</code> request parameters. /// </para> /// /// <para> /// 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. /// </para> /// /// <para> /// For more information on multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html">Uploading /// Objects Using Multipart Upload</a>. /// </para> /// /// <para> /// For information on permissions required to use the multipart upload API, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html">Multipart /// Upload and Permissions</a>. /// </para> /// /// <para> /// The following operations are related to <code>ListMultipartUploads</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html">CreateMultipartUpload</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html">UploadPart</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html">CompleteMultipartUpload</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html">ListParts</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html">AbortMultipartUpload</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the ListMultipartUploads service method.</param> /// /// <returns>The response from the ListMultipartUploads service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListMultipartUploads">REST API Reference for ListMultipartUploads Operation</seealso> ListMultipartUploadsResponse ListMultipartUploads(ListMultipartUploadsRequest request); /// <summary> /// Initiates the asynchronous execution of the ListMultipartUploads operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the ListMultipartUploads operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListMultipartUploads /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListMultipartUploads">REST API Reference for ListMultipartUploads Operation</seealso> IAsyncResult BeginListMultipartUploads(ListMultipartUploadsRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the ListMultipartUploads operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginListMultipartUploads.</param> /// /// <returns>Returns a ListMultipartUploadsResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListMultipartUploads">REST API Reference for ListMultipartUploads Operation</seealso> ListMultipartUploadsResponse EndListMultipartUploads(IAsyncResult asyncResult); #endregion #region ListObjects /// <summary> /// 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. /// /// <important> /// <para> /// This action has been revised. We recommend that you use the newer version, <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html">ListObjectsV2</a>, /// when developing applications. For backward compatibility, Amazon S3 continues to support /// <code>ListObjects</code>. /// </para> /// </important> /// <para> /// The following operations are related to <code>ListObjects</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html">ListObjectsV2</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html">PutObject</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html">ListBuckets</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="bucketName">The name of the bucket containing the objects. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>. When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</param> /// /// <returns>The response from the ListObjects service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjects">REST API Reference for ListObjects Operation</seealso> ListObjectsResponse ListObjects(string bucketName); /// <summary> /// 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. /// /// <important> /// <para> /// This action has been revised. We recommend that you use the newer version, <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html">ListObjectsV2</a>, /// when developing applications. For backward compatibility, Amazon S3 continues to support /// <code>ListObjects</code>. /// </para> /// </important> /// <para> /// The following operations are related to <code>ListObjects</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html">ListObjectsV2</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html">PutObject</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html">ListBuckets</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="bucketName">The name of the bucket containing the objects. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>. When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</param> /// <param name="prefix">Limits the response to keys that begin with the specified prefix.</param> /// /// <returns>The response from the ListObjects service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjects">REST API Reference for ListObjects Operation</seealso> ListObjectsResponse ListObjects(string bucketName, string prefix); /// <summary> /// 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. /// /// <important> /// <para> /// This action has been revised. We recommend that you use the newer version, <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html">ListObjectsV2</a>, /// when developing applications. For backward compatibility, Amazon S3 continues to support /// <code>ListObjects</code>. /// </para> /// </important> /// <para> /// The following operations are related to <code>ListObjects</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html">ListObjectsV2</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html">PutObject</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html">ListBuckets</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the ListObjects service method.</param> /// /// <returns>The response from the ListObjects service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjects">REST API Reference for ListObjects Operation</seealso> ListObjectsResponse ListObjects(ListObjectsRequest request); /// <summary> /// Initiates the asynchronous execution of the ListObjects operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the ListObjects operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListObjects /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjects">REST API Reference for ListObjects Operation</seealso> IAsyncResult BeginListObjects(ListObjectsRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the ListObjects operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginListObjects.</param> /// /// <returns>Returns a ListObjectsResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjects">REST API Reference for ListObjects Operation</seealso> ListObjectsResponse EndListObjects(IAsyncResult asyncResult); #endregion #region ListObjectsV2 /// <summary> /// 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 <code>200 OK</code> 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/ListingKeysUsingAPIs.html">Listing /// object keys programmatically</a> in the <i>Amazon S3 User Guide</i>. /// /// /// <para> /// To use this operation, you must have READ access to the bucket. /// </para> /// /// <para> /// To use this action in an Identity and Access Management (IAM) policy, you must have /// permission to perform the <code>s3:ListBucket</code> action. The bucket owner has /// this permission by default and can grant this permission to others. For more information /// about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions /// Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing /// Access Permissions to Your Amazon S3 Resources</a> in the <i>Amazon S3 User Guide</i>. /// </para> /// <important> /// <para> /// This section describes the latest revision of this action. We recommend that you use /// this revised API operation for application development. For backward compatibility, /// Amazon S3 continues to support the prior version of this API operation, <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html">ListObjects</a>. /// </para> /// </important> /// <para> /// To get a list of your buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html">ListBuckets</a>. /// </para> /// /// <para> /// The following operations are related to <code>ListObjectsV2</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html">PutObject</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the ListObjectsV2 service method.</param> /// /// <returns>The response from the ListObjectsV2 service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjectsV2">REST API Reference for ListObjectsV2 Operation</seealso> ListObjectsV2Response ListObjectsV2(ListObjectsV2Request request); /// <summary> /// Initiates the asynchronous execution of the ListObjectsV2 operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the ListObjectsV2 operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListObjectsV2 /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjectsV2">REST API Reference for ListObjectsV2 Operation</seealso> IAsyncResult BeginListObjectsV2(ListObjectsV2Request request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the ListObjectsV2 operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginListObjectsV2.</param> /// /// <returns>Returns a ListObjectsV2Result from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjectsV2">REST API Reference for ListObjectsV2 Operation</seealso> ListObjectsV2Response EndListObjectsV2(IAsyncResult asyncResult); #endregion #region ListParts /// <summary> /// 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html">CreateMultipartUpload</a>). /// 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 <code>max-parts</code> request parameter. If your multipart upload consists of /// more than 1,000 parts, the response returns an <code>IsTruncated</code> field with /// the value of true, and a <code>NextPartNumberMarker</code> element. In subsequent /// <code>ListParts</code> requests you can include the part-number-marker query string /// parameter and set its value to the <code>NextPartNumberMarker</code> field value from /// the previous response. /// /// /// <para> /// If the upload was created using a checksum algorithm, you will need to have permission /// to the <code>kms:Decrypt</code> action for the request to succeed. /// </para> /// /// <para> /// For more information on multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html">Uploading /// Objects Using Multipart Upload</a>. /// </para> /// /// <para> /// For information on permissions required to use the multipart upload API, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html">Multipart /// Upload and Permissions</a>. /// </para> /// /// <para> /// The following operations are related to <code>ListParts</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html">CreateMultipartUpload</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html">UploadPart</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html">CompleteMultipartUpload</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html">AbortMultipartUpload</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html">GetObjectAttributes</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html">ListMultipartUploads</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="bucketName">The name of the bucket to which the parts are being uploaded. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>. When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</param> /// <param name="key">Object key for which the multipart upload was initiated.</param> /// <param name="uploadId">Upload ID identifying the multipart upload whose parts are being listed.</param> /// /// <returns>The response from the ListParts service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListParts">REST API Reference for ListParts Operation</seealso> ListPartsResponse ListParts(string bucketName, string key, string uploadId); /// <summary> /// 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html">CreateMultipartUpload</a>). /// 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 <code>max-parts</code> request parameter. If your multipart upload consists of /// more than 1,000 parts, the response returns an <code>IsTruncated</code> field with /// the value of true, and a <code>NextPartNumberMarker</code> element. In subsequent /// <code>ListParts</code> requests you can include the part-number-marker query string /// parameter and set its value to the <code>NextPartNumberMarker</code> field value from /// the previous response. /// /// /// <para> /// If the upload was created using a checksum algorithm, you will need to have permission /// to the <code>kms:Decrypt</code> action for the request to succeed. /// </para> /// /// <para> /// For more information on multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html">Uploading /// Objects Using Multipart Upload</a>. /// </para> /// /// <para> /// For information on permissions required to use the multipart upload API, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html">Multipart /// Upload and Permissions</a>. /// </para> /// /// <para> /// The following operations are related to <code>ListParts</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html">CreateMultipartUpload</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html">UploadPart</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html">CompleteMultipartUpload</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html">AbortMultipartUpload</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html">GetObjectAttributes</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html">ListMultipartUploads</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the ListParts service method.</param> /// /// <returns>The response from the ListParts service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListParts">REST API Reference for ListParts Operation</seealso> ListPartsResponse ListParts(ListPartsRequest request); /// <summary> /// Initiates the asynchronous execution of the ListParts operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the ListParts operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListParts /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListParts">REST API Reference for ListParts Operation</seealso> IAsyncResult BeginListParts(ListPartsRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the ListParts operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginListParts.</param> /// /// <returns>Returns a ListPartsResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListParts">REST API Reference for ListParts Operation</seealso> ListPartsResponse EndListParts(IAsyncResult asyncResult); #endregion #region ListVersions /// <summary> /// 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. /// /// <important> /// <para> /// To use this operation, you must have permission to perform the <code>s3:ListBucketVersions</code> /// action. Be aware of the name difference. /// </para> /// </important> <note> /// <para> /// A <code>200 OK</code> response can contain valid or invalid XML. Make sure to design /// your application to parse the contents of the response and handle it appropriately. /// </para> /// </note> /// <para> /// To use this operation, you must have READ access to the bucket. /// </para> /// /// <para> /// This action is not supported by Amazon S3 on Outposts. /// </para> /// /// <para> /// The following operations are related to <code>ListObjectVersions</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html">ListObjectsV2</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html">PutObject</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html">DeleteObject</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="bucketName">The bucket name that contains the objects. </param> /// /// <returns>The response from the ListVersions service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjectVersions">REST API Reference for ListVersions Operation</seealso> ListVersionsResponse ListVersions(string bucketName); /// <summary> /// 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. /// /// <important> /// <para> /// To use this operation, you must have permission to perform the <code>s3:ListBucketVersions</code> /// action. Be aware of the name difference. /// </para> /// </important> <note> /// <para> /// A <code>200 OK</code> response can contain valid or invalid XML. Make sure to design /// your application to parse the contents of the response and handle it appropriately. /// </para> /// </note> /// <para> /// To use this operation, you must have READ access to the bucket. /// </para> /// /// <para> /// This action is not supported by Amazon S3 on Outposts. /// </para> /// /// <para> /// The following operations are related to <code>ListObjectVersions</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html">ListObjectsV2</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html">PutObject</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html">DeleteObject</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="bucketName">The bucket name that contains the objects. </param> /// <param name="prefix">Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using <code>prefix</code> to make groups in the same way that you'd use a folder in a file system.) You can use <code>prefix</code> with <code>delimiter</code> to roll up numerous objects into a single result under <code>CommonPrefixes</code>. </param> /// /// <returns>The response from the ListVersions service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjectVersions">REST API Reference for ListVersions Operation</seealso> ListVersionsResponse ListVersions(string bucketName, string prefix); /// <summary> /// 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. /// /// <important> /// <para> /// To use this operation, you must have permission to perform the <code>s3:ListBucketVersions</code> /// action. Be aware of the name difference. /// </para> /// </important> <note> /// <para> /// A <code>200 OK</code> response can contain valid or invalid XML. Make sure to design /// your application to parse the contents of the response and handle it appropriately. /// </para> /// </note> /// <para> /// To use this operation, you must have READ access to the bucket. /// </para> /// /// <para> /// This action is not supported by Amazon S3 on Outposts. /// </para> /// /// <para> /// The following operations are related to <code>ListObjectVersions</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html">ListObjectsV2</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html">PutObject</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html">DeleteObject</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the ListVersions service method.</param> /// /// <returns>The response from the ListVersions service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjectVersions">REST API Reference for ListVersions Operation</seealso> ListVersionsResponse ListVersions(ListVersionsRequest request); /// <summary> /// Initiates the asynchronous execution of the ListVersions operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the ListVersions operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListVersions /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjectVersions">REST API Reference for ListVersions Operation</seealso> IAsyncResult BeginListVersions(ListVersionsRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the ListVersions operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginListVersions.</param> /// /// <returns>Returns a ListVersionsResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjectVersions">REST API Reference for ListVersions Operation</seealso> ListVersionsResponse EndListVersions(IAsyncResult asyncResult); #endregion #region PutACL /// <summary> /// Sets the permissions on an existing bucket using access control lists (ACL). For more /// information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html">Using /// ACLs</a>. To set the ACL of a bucket, you must have <code>WRITE_ACP</code> permission. /// /// /// <para> /// You can use one of the following two ways to set a bucket's permissions: /// </para> /// <ul> <li> /// <para> /// Specify the ACL in the request body /// </para> /// </li> <li> /// <para> /// Specify permissions using request headers /// </para> /// </li> </ul> <note> /// <para> /// You cannot specify access permission using both the body and the request headers. /// </para> /// </note> /// <para> /// 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. /// </para> /// <important> /// <para> /// 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 <code>AccessControlListNotSupported</code> error code. Requests to read /// ACLs are still supported. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html">Controlling /// object ownership</a> in the <i>Amazon S3 User Guide</i>. /// </para> /// </important> <dl> <dt>Permissions</dt> <dd> /// <para> /// You can set access permissions by using one of the following methods: /// </para> /// <ul> <li> /// <para> /// Specify a canned ACL with the <code>x-amz-acl</code> request header. Amazon S3 supports /// a set of predefined ACLs, known as <i>canned ACLs</i>. Each canned ACL has a predefined /// set of grantees and permissions. Specify the canned ACL name as the value of <code>x-amz-acl</code>. /// If you use this header, you cannot use other access control-specific headers in your /// request. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL">Canned /// ACL</a>. /// </para> /// </li> <li> /// <para> /// Specify access permissions explicitly with the <code>x-amz-grant-read</code>, <code>x-amz-grant-read-acp</code>, /// <code>x-amz-grant-write-acp</code>, and <code>x-amz-grant-full-control</code> 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 <code>x-amz-acl</code> 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html">Access /// Control List (ACL) Overview</a>. /// </para> /// /// <para> /// You specify each grantee as a type=value pair, where the type is one of the following: /// </para> /// <ul> <li> /// <para> /// <code>id</code> – if the value specified is the canonical user ID of an Amazon Web /// Services account /// </para> /// </li> <li> /// <para> /// <code>uri</code> – if you are granting permissions to a predefined group /// </para> /// </li> <li> /// <para> /// <code>emailAddress</code> – if the value specified is the email address of an Amazon /// Web Services account /// </para> /// <note> /// <para> /// Using email addresses to specify a grantee is only supported in the following Amazon /// Web Services Regions: /// </para> /// <ul> <li> /// <para> /// US East (N. Virginia) /// </para> /// </li> <li> /// <para> /// US West (N. California) /// </para> /// </li> <li> /// <para> /// US West (Oregon) /// </para> /// </li> <li> /// <para> /// Asia Pacific (Singapore) /// </para> /// </li> <li> /// <para> /// Asia Pacific (Sydney) /// </para> /// </li> <li> /// <para> /// Asia Pacific (Tokyo) /// </para> /// </li> <li> /// <para> /// Europe (Ireland) /// </para> /// </li> <li> /// <para> /// South America (São Paulo) /// </para> /// </li> </ul> /// <para> /// For a list of all the Amazon S3 supported Regions and endpoints, see <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region">Regions /// and Endpoints</a> in the Amazon Web Services General Reference. /// </para> /// </note> </li> </ul> /// <para> /// For example, the following <code>x-amz-grant-write</code> 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. /// </para> /// /// <para> /// <code>x-amz-grant-write: uri="http://acs.amazonaws.com/groups/s3/LogDelivery", id="111122223333", /// id="555566667777" </code> /// </para> /// </li> </ul> /// <para> /// You can use either a canned ACL or specify access permissions explicitly. You cannot /// do both. /// </para> /// </dd> <dt>Grantee Values</dt> <dd> /// <para> /// You can specify the person (grantee) to whom you're assigning access rights (using /// request elements) in the following ways: /// </para> /// <ul> <li> /// <para> /// By the person's ID: /// </para> /// /// <para> /// <code><Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> /// </Grantee></code> /// </para> /// /// <para> /// DisplayName is optional and ignored in the request /// </para> /// </li> <li> /// <para> /// By URI: /// </para> /// /// <para> /// <code><Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee></code> /// /// </para> /// </li> <li> /// <para> /// By Email address: /// </para> /// /// <para> /// <code><Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress>&</Grantee></code> /// /// </para> /// /// <para> /// The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl /// request, appears as the CanonicalUser. /// </para> /// <note> /// <para> /// Using email addresses to specify a grantee is only supported in the following Amazon /// Web Services Regions: /// </para> /// <ul> <li> /// <para> /// US East (N. Virginia) /// </para> /// </li> <li> /// <para> /// US West (N. California) /// </para> /// </li> <li> /// <para> /// US West (Oregon) /// </para> /// </li> <li> /// <para> /// Asia Pacific (Singapore) /// </para> /// </li> <li> /// <para> /// Asia Pacific (Sydney) /// </para> /// </li> <li> /// <para> /// Asia Pacific (Tokyo) /// </para> /// </li> <li> /// <para> /// Europe (Ireland) /// </para> /// </li> <li> /// <para> /// South America (São Paulo) /// </para> /// </li> </ul> /// <para> /// For a list of all the Amazon S3 supported Regions and endpoints, see <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region">Regions /// and Endpoints</a> in the Amazon Web Services General Reference. /// </para> /// </note> </li> </ul> </dd> </dl> /// <para> /// The following operations are related to <code>PutBucketAcl</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html">DeleteBucket</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html">GetObjectAcl</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the PutACL service method.</param> /// /// <returns>The response from the PutACL service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketAcl">REST API Reference for PutACL Operation</seealso> PutACLResponse PutACL(PutACLRequest request); /// <summary> /// Initiates the asynchronous execution of the PutACL operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the PutACL operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutACL /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketAcl">REST API Reference for PutACL Operation</seealso> IAsyncResult BeginPutACL(PutACLRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the PutACL operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginPutACL.</param> /// /// <returns>Returns a PutACLResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketAcl">REST API Reference for PutACL Operation</seealso> PutACLResponse EndPutACL(IAsyncResult asyncResult); #endregion #region PutBucket /// <summary> /// 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. /// /// /// <para> /// Not every string is an acceptable bucket name. For information about bucket naming /// restrictions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html">Bucket /// naming rules</a>. /// </para> /// /// <para> /// If you want to create an Amazon S3 on Outposts bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateBucket.html">Create /// Bucket</a>. /// </para> /// /// <para> /// 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro">Accessing /// a bucket</a>. /// </para> /// <note> /// <para> /// If you send your create bucket request to the <code>s3.amazonaws.com</code> endpoint, /// the request goes to the <code>us-east-1</code> Region. Accordingly, the signature /// calculations in Signature Version 4 must use <code>us-east-1</code> 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html">Virtual /// hosting of buckets</a>. /// </para> /// </note> <dl> <dt>Permissions</dt> <dd> /// <para> /// In addition to <code>s3:CreateBucket</code>, the following permissions are required /// when your <code>CreateBucket</code> request includes specific headers: /// </para> /// <ul> <li> /// <para> /// <b>Access control lists (ACLs)</b> - If your <code>CreateBucket</code> request specifies /// access control list (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 <code>s3:CreateBucket</code> and <code>s3:PutBucketAcl</code> permissions /// are needed. If the ACL for the <code>CreateBucket</code> request is private or if /// the request doesn't specify any ACLs, only <code>s3:CreateBucket</code> permission /// is needed. /// </para> /// </li> <li> /// <para> /// <b>Object Lock</b> - If <code>ObjectLockEnabledForBucket</code> is set to true in /// your <code>CreateBucket</code> request, <code>s3:PutBucketObjectLockConfiguration</code> /// and <code>s3:PutBucketVersioning</code> permissions are required. /// </para> /// </li> <li> /// <para> /// <b>S3 Object Ownership</b> - If your <code>CreateBucket</code> request includes the /// <code>x-amz-object-ownership</code> header, then the <code>s3:PutBucketOwnershipControls</code> /// permission is required. By default, <code>ObjectOwnership</code> is set to <code>BucketOWnerEnforced</code> /// and ACLs are disabled. We recommend keeping ACLs disabled, except in uncommon use /// cases where you must control access for each object individually. If you want to change /// the <code>ObjectOwnership</code> setting, you can use the <code>x-amz-object-ownership</code> /// header in your <code>CreateBucket</code> request to set the <code>ObjectOwnership</code> /// setting of your choice. For more information about S3 Object Ownership, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html">Controlling /// object ownership </a> in the <i>Amazon S3 User Guide</i>. /// </para> /// </li> <li> /// <para> /// <b>S3 Block Public Access</b> - If your specific use case requires granting public /// access to your S3 resources, you can disable Block Public Access. You can create a /// new bucket with Block Public Access enabled, then separately call the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeletePublicAccessBlock.html"> /// <code>DeletePublicAccessBlock</code> </a> API. To use this operation, you must have /// the <code>s3:PutBucketPublicAccessBlock</code> permission. By default, all Block Public /// Access settings are enabled for new buckets. To avoid inadvertent exposure of your /// resources, we recommend keeping the S3 Block Public Access settings enabled. For more /// information about S3 Block Public Access, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html">Blocking /// public access to your Amazon S3 storage </a> in the <i>Amazon S3 User Guide</i>. /// </para> /// </li> </ul> </dd> </dl> <important> /// <para> /// If your <code>CreateBucket</code> request sets <code>BucketOwnerEnforced</code> for /// Amazon S3 Object Ownership and specifies a bucket ACL that provides access to an external /// Amazon Web Services account, your request fails with a <code>400</code> error and /// returns the <code>InvalidBucketAcLWithObjectOwnership</code> error code. For more /// information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-ownership-existing-bucket.html">Setting /// Object Ownership on an existing bucket </a> in the <i>Amazon S3 User Guide</i>. /// </para> /// </important> /// <para> /// The following operations are related to <code>CreateBucket</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html">PutObject</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html">DeleteBucket</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="bucketName">The name of the bucket to create.</param> /// /// <returns>The response from the PutBucket service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/CreateBucket">REST API Reference for PutBucket Operation</seealso> PutBucketResponse PutBucket(string bucketName); /// <summary> /// 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. /// /// /// <para> /// Not every string is an acceptable bucket name. For information about bucket naming /// restrictions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html">Bucket /// naming rules</a>. /// </para> /// /// <para> /// If you want to create an Amazon S3 on Outposts bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateBucket.html">Create /// Bucket</a>. /// </para> /// /// <para> /// 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro">Accessing /// a bucket</a>. /// </para> /// <note> /// <para> /// If you send your create bucket request to the <code>s3.amazonaws.com</code> endpoint, /// the request goes to the <code>us-east-1</code> Region. Accordingly, the signature /// calculations in Signature Version 4 must use <code>us-east-1</code> 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html">Virtual /// hosting of buckets</a>. /// </para> /// </note> <dl> <dt>Permissions</dt> <dd> /// <para> /// In addition to <code>s3:CreateBucket</code>, the following permissions are required /// when your <code>CreateBucket</code> request includes specific headers: /// </para> /// <ul> <li> /// <para> /// <b>Access control lists (ACLs)</b> - If your <code>CreateBucket</code> request specifies /// access control list (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 <code>s3:CreateBucket</code> and <code>s3:PutBucketAcl</code> permissions /// are needed. If the ACL for the <code>CreateBucket</code> request is private or if /// the request doesn't specify any ACLs, only <code>s3:CreateBucket</code> permission /// is needed. /// </para> /// </li> <li> /// <para> /// <b>Object Lock</b> - If <code>ObjectLockEnabledForBucket</code> is set to true in /// your <code>CreateBucket</code> request, <code>s3:PutBucketObjectLockConfiguration</code> /// and <code>s3:PutBucketVersioning</code> permissions are required. /// </para> /// </li> <li> /// <para> /// <b>S3 Object Ownership</b> - If your <code>CreateBucket</code> request includes the /// <code>x-amz-object-ownership</code> header, then the <code>s3:PutBucketOwnershipControls</code> /// permission is required. By default, <code>ObjectOwnership</code> is set to <code>BucketOWnerEnforced</code> /// and ACLs are disabled. We recommend keeping ACLs disabled, except in uncommon use /// cases where you must control access for each object individually. If you want to change /// the <code>ObjectOwnership</code> setting, you can use the <code>x-amz-object-ownership</code> /// header in your <code>CreateBucket</code> request to set the <code>ObjectOwnership</code> /// setting of your choice. For more information about S3 Object Ownership, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html">Controlling /// object ownership </a> in the <i>Amazon S3 User Guide</i>. /// </para> /// </li> <li> /// <para> /// <b>S3 Block Public Access</b> - If your specific use case requires granting public /// access to your S3 resources, you can disable Block Public Access. You can create a /// new bucket with Block Public Access enabled, then separately call the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeletePublicAccessBlock.html"> /// <code>DeletePublicAccessBlock</code> </a> API. To use this operation, you must have /// the <code>s3:PutBucketPublicAccessBlock</code> permission. By default, all Block Public /// Access settings are enabled for new buckets. To avoid inadvertent exposure of your /// resources, we recommend keeping the S3 Block Public Access settings enabled. For more /// information about S3 Block Public Access, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html">Blocking /// public access to your Amazon S3 storage </a> in the <i>Amazon S3 User Guide</i>. /// </para> /// </li> </ul> </dd> </dl> <important> /// <para> /// If your <code>CreateBucket</code> request sets <code>BucketOwnerEnforced</code> for /// Amazon S3 Object Ownership and specifies a bucket ACL that provides access to an external /// Amazon Web Services account, your request fails with a <code>400</code> error and /// returns the <code>InvalidBucketAcLWithObjectOwnership</code> error code. For more /// information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-ownership-existing-bucket.html">Setting /// Object Ownership on an existing bucket </a> in the <i>Amazon S3 User Guide</i>. /// </para> /// </important> /// <para> /// The following operations are related to <code>CreateBucket</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html">PutObject</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html">DeleteBucket</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the PutBucket service method.</param> /// /// <returns>The response from the PutBucket service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/CreateBucket">REST API Reference for PutBucket Operation</seealso> PutBucketResponse PutBucket(PutBucketRequest request); /// <summary> /// Initiates the asynchronous execution of the PutBucket operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the PutBucket operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucket /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/CreateBucket">REST API Reference for PutBucket Operation</seealso> IAsyncResult BeginPutBucket(PutBucketRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the PutBucket operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginPutBucket.</param> /// /// <returns>Returns a PutBucketResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/CreateBucket">REST API Reference for PutBucket Operation</seealso> PutBucketResponse EndPutBucket(IAsyncResult asyncResult); #endregion #region PutBucketAccelerateConfiguration /// <summary> /// 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. /// /// /// <para> /// To use this operation, you must have permission to perform the <code>s3:PutAccelerateConfiguration</code> /// action. The bucket owner has this permission by default. The bucket owner can grant /// this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions /// Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing /// Access Permissions to Your Amazon S3 Resources</a>. /// </para> /// /// <para> /// The Transfer Acceleration state of a bucket can be set to one of the following two /// values: /// </para> /// <ul> <li> /// <para> /// Enabled – Enables accelerated data transfers to the bucket. /// </para> /// </li> <li> /// <para> /// Suspended – Disables accelerated data transfers to the bucket. /// </para> /// </li> </ul> /// <para> /// The <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAccelerateConfiguration.html">GetBucketAccelerateConfiguration</a> /// action returns the transfer acceleration state of a bucket. /// </para> /// /// <para> /// 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. /// </para> /// /// <para> /// The name of the bucket used for Transfer Acceleration must be DNS-compliant and must /// not contain periods ("."). /// </para> /// /// <para> /// For more information about transfer acceleration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html">Transfer /// Acceleration</a>. /// </para> /// /// <para> /// The following operations are related to <code>PutBucketAccelerateConfiguration</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAccelerateConfiguration.html">GetBucketAccelerateConfiguration</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the PutBucketAccelerateConfiguration service method.</param> /// /// <returns>The response from the PutBucketAccelerateConfiguration service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketAccelerateConfiguration">REST API Reference for PutBucketAccelerateConfiguration Operation</seealso> PutBucketAccelerateConfigurationResponse PutBucketAccelerateConfiguration(PutBucketAccelerateConfigurationRequest request); /// <summary> /// Initiates the asynchronous execution of the PutBucketAccelerateConfiguration operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the PutBucketAccelerateConfiguration operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketAccelerateConfiguration /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketAccelerateConfiguration">REST API Reference for PutBucketAccelerateConfiguration Operation</seealso> IAsyncResult BeginPutBucketAccelerateConfiguration(PutBucketAccelerateConfigurationRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the PutBucketAccelerateConfiguration operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginPutBucketAccelerateConfiguration.</param> /// /// <returns>Returns a PutBucketAccelerateConfigurationResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketAccelerateConfiguration">REST API Reference for PutBucketAccelerateConfiguration Operation</seealso> PutBucketAccelerateConfigurationResponse EndPutBucketAccelerateConfiguration(IAsyncResult asyncResult); #endregion #region PutBucketAnalyticsConfiguration /// <summary> /// Sets an analytics configuration for the bucket (specified by the analytics configuration /// ID). You can have up to 1,000 analytics configurations per bucket. /// /// /// <para> /// You can choose to have storage class analysis export analysis reports sent to a comma-separated /// values (CSV) flat file. See the <code>DataExport</code> 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 /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html">Amazon /// S3 Analytics – Storage Class Analysis</a>. /// </para> /// <important> /// <para> /// 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/example-bucket-policies.html#example-bucket-policies-use-case-9">Granting /// Permissions for Amazon S3 Inventory and Storage Class Analysis</a>. /// </para> /// </important> /// <para> /// To use this operation, you must have permissions to perform the <code>s3:PutAnalyticsConfiguration</code> /// action. The bucket owner has this permission by default. The bucket owner can grant /// this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions /// Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing /// Access Permissions to Your Amazon S3 Resources</a>. /// </para> /// /// <para> /// <code>PutBucketAnalyticsConfiguration</code> has the following special errors: /// </para> /// <ul> <li> <ul> <li> /// <para> /// <i>HTTP Error: HTTP 400 Bad Request</i> /// </para> /// </li> <li> /// <para> /// <i>Code: InvalidArgument</i> /// </para> /// </li> <li> /// <para> /// <i>Cause: Invalid argument.</i> /// </para> /// </li> </ul> </li> <li> <ul> <li> /// <para> /// <i>HTTP Error: HTTP 400 Bad Request</i> /// </para> /// </li> <li> /// <para> /// <i>Code: TooManyConfigurations</i> /// </para> /// </li> <li> /// <para> /// <i>Cause: You are attempting to create a new configuration but have already reached /// the 1,000-configuration limit.</i> /// </para> /// </li> </ul> </li> <li> <ul> <li> /// <para> /// <i>HTTP Error: HTTP 403 Forbidden</i> /// </para> /// </li> <li> /// <para> /// <i>Code: AccessDenied</i> /// </para> /// </li> <li> /// <para> /// <i>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.</i> /// </para> /// </li> </ul> </li> </ul> /// <para> /// The following operations are related to <code>PutBucketAnalyticsConfiguration</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAnalyticsConfiguration.html">GetBucketAnalyticsConfiguration</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketAnalyticsConfiguration.html">DeleteBucketAnalyticsConfiguration</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketAnalyticsConfigurations.html">ListBucketAnalyticsConfigurations</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the PutBucketAnalyticsConfiguration service method.</param> /// /// <returns>The response from the PutBucketAnalyticsConfiguration service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketAnalyticsConfiguration">REST API Reference for PutBucketAnalyticsConfiguration Operation</seealso> PutBucketAnalyticsConfigurationResponse PutBucketAnalyticsConfiguration(PutBucketAnalyticsConfigurationRequest request); /// <summary> /// Initiates the asynchronous execution of the PutBucketAnalyticsConfiguration operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the PutBucketAnalyticsConfiguration operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketAnalyticsConfiguration /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketAnalyticsConfiguration">REST API Reference for PutBucketAnalyticsConfiguration Operation</seealso> IAsyncResult BeginPutBucketAnalyticsConfiguration(PutBucketAnalyticsConfigurationRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the PutBucketAnalyticsConfiguration operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginPutBucketAnalyticsConfiguration.</param> /// /// <returns>Returns a PutBucketAnalyticsConfigurationResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketAnalyticsConfiguration">REST API Reference for PutBucketAnalyticsConfiguration Operation</seealso> PutBucketAnalyticsConfigurationResponse EndPutBucketAnalyticsConfiguration(IAsyncResult asyncResult); #endregion #region PutBucketEncryption /// <summary> /// This action uses the <code>encryption</code> subresource to configure default encryption /// and Amazon S3 Bucket Keys for an existing bucket. /// /// /// <para> /// By default, all buckets have a default encryption configuration that uses server-side /// encryption with Amazon S3 managed keys (SSE-S3). You can optionally configure default /// encryption for a bucket by using server-side encryption with Key Management Service /// (KMS) keys (SSE-KMS), dual-layer server-side encryption with Amazon Web Services KMS /// keys (DSSE-KMS), or server-side encryption with customer-provided keys (SSE-C). If /// you specify default encryption by using SSE-KMS, you can also configure Amazon S3 /// Bucket Keys. For information about bucket default encryption, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html">Amazon /// S3 bucket default encryption</a> in the <i>Amazon S3 User Guide</i>. For more information /// about S3 Bucket Keys, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html">Amazon /// S3 Bucket Keys</a> in the <i>Amazon S3 User Guide</i>. /// </para> /// <important> /// <para> /// This action requires Amazon Web Services Signature Version 4. For more information, /// see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html"> /// Authenticating Requests (Amazon Web Services Signature Version 4)</a>. /// </para> /// </important> /// <para> /// To use this operation, you must have permission to perform the <code>s3:PutEncryptionConfiguration</code> /// action. The bucket owner has this permission by default. The bucket owner can grant /// this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions /// Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing /// Access Permissions to Your Amazon S3 Resources</a> in the <i>Amazon S3 User Guide</i>. /// /// </para> /// /// <para> /// The following operations are related to <code>PutBucketEncryption</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketEncryption.html">GetBucketEncryption</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketEncryption.html">DeleteBucketEncryption</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the PutBucketEncryption service method.</param> /// /// <returns>The response from the PutBucketEncryption service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketEncryption">REST API Reference for PutBucketEncryption Operation</seealso> PutBucketEncryptionResponse PutBucketEncryption(PutBucketEncryptionRequest request); /// <summary> /// Initiates the asynchronous execution of the PutBucketEncryption operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the PutBucketEncryption operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketEncryption /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketEncryption">REST API Reference for PutBucketEncryption Operation</seealso> IAsyncResult BeginPutBucketEncryption(PutBucketEncryptionRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the PutBucketEncryption operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginPutBucketEncryption.</param> /// /// <returns>Returns a PutBucketEncryptionResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketEncryption">REST API Reference for PutBucketEncryption Operation</seealso> PutBucketEncryptionResponse EndPutBucketEncryption(IAsyncResult asyncResult); #endregion #region PutBucketIntelligentTieringConfiguration /// <summary> /// Puts a S3 Intelligent-Tiering configuration to the specified bucket. You can have /// up to 1,000 S3 Intelligent-Tiering configurations per bucket. /// /// /// <para> /// 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. /// </para> /// /// <para> /// 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. /// </para> /// /// <para> /// For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access">Storage /// class for automatically optimizing frequently and infrequently accessed objects</a>. /// </para> /// /// <para> /// Operations related to <code>PutBucketIntelligentTieringConfiguration</code> include: /// /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketIntelligentTieringConfiguration.html">DeleteBucketIntelligentTieringConfiguration</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketIntelligentTieringConfiguration.html">GetBucketIntelligentTieringConfiguration</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketIntelligentTieringConfigurations.html">ListBucketIntelligentTieringConfigurations</a> /// /// </para> /// </li> </ul> <note> /// <para> /// 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. /// </para> /// </note> /// <para> /// <code>PutBucketIntelligentTieringConfiguration</code> has the following special errors: /// </para> /// <dl> <dt>HTTP 400 Bad Request Error</dt> <dd> /// <para> /// <i>Code:</i> InvalidArgument /// </para> /// /// <para> /// <i>Cause:</i> Invalid Argument /// </para> /// </dd> <dt>HTTP 400 Bad Request Error</dt> <dd> /// <para> /// <i>Code:</i> TooManyConfigurations /// </para> /// /// <para> /// <i>Cause:</i> You are attempting to create a new configuration but have already reached /// the 1,000-configuration limit. /// </para> /// </dd> <dt>HTTP 403 Forbidden Error</dt> <dd> /// <para> /// <i>Cause:</i> You are not the owner of the specified bucket, or you do not have the /// <code>s3:PutIntelligentTieringConfiguration</code> bucket permission to set the configuration /// on the bucket. /// </para> /// </dd> </dl> /// </summary> /// <param name="request">Container for the necessary parameters to execute the PutBucketIntelligentTieringConfiguration service method.</param> /// /// <returns>The response from the PutBucketIntelligentTieringConfiguration service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketIntelligentTieringConfiguration">REST API Reference for PutBucketIntelligentTieringConfiguration Operation</seealso> PutBucketIntelligentTieringConfigurationResponse PutBucketIntelligentTieringConfiguration(PutBucketIntelligentTieringConfigurationRequest request); /// <summary> /// Initiates the asynchronous execution of the PutBucketIntelligentTieringConfiguration operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the PutBucketIntelligentTieringConfiguration operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketIntelligentTieringConfiguration /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketIntelligentTieringConfiguration">REST API Reference for PutBucketIntelligentTieringConfiguration Operation</seealso> IAsyncResult BeginPutBucketIntelligentTieringConfiguration(PutBucketIntelligentTieringConfigurationRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the PutBucketIntelligentTieringConfiguration operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginPutBucketIntelligentTieringConfiguration.</param> /// /// <returns>Returns a PutBucketIntelligentTieringConfigurationResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketIntelligentTieringConfiguration">REST API Reference for PutBucketIntelligentTieringConfiguration Operation</seealso> PutBucketIntelligentTieringConfigurationResponse EndPutBucketIntelligentTieringConfiguration(IAsyncResult asyncResult); #endregion #region PutBucketInventoryConfiguration /// <summary> /// This implementation of the <code>PUT</code> action adds an inventory configuration /// (identified by the inventory ID) to the bucket. You can have up to 1,000 inventory /// configurations per bucket. /// /// /// <para> /// 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 <i>source</i> bucket, and the bucket where the inventory /// flat file is stored is called the <i>destination</i> bucket. The <i>destination</i> /// bucket must be in the same Amazon Web Services Region as the <i>source</i> bucket. /// /// </para> /// /// <para> /// When you configure an inventory for a <i>source</i> bucket, you specify the <i>destination</i> /// 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 /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html">Amazon /// S3 Inventory</a> in the Amazon S3 User Guide. /// </para> /// <important> /// <para> /// You must create a bucket policy on the <i>destination</i> bucket to grant permissions /// to Amazon S3 to write objects to the bucket in the defined location. For an example /// policy, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/example-bucket-policies.html#example-bucket-policies-use-case-9"> /// Granting Permissions for Amazon S3 Inventory and Storage Class Analysis</a>. /// </para> /// </important> <dl> <dt>Permissions</dt> <dd> /// <para> /// To use this operation, you must have permission to perform the <code>s3:PutInventoryConfiguration</code> /// action. The bucket owner has this permission by default and can grant this permission /// to others. /// </para> /// /// <para> /// The <code>s3:PutInventoryConfiguration</code> permission allows a user to create an /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage-inventory.html">S3 /// Inventory</a> report that includes all object metadata fields available and to specify /// the destination bucket to store the inventory. A user with read access to objects /// in the destination bucket can also access all object metadata fields that are available /// in the inventory report. /// </para> /// /// <para> /// To restrict access to an inventory report, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html#example-bucket-policies-use-case-10">Restricting /// access to an Amazon S3 Inventory report</a> in the <i>Amazon S3 User Guide</i>. For /// more information about the metadata fields available in S3 Inventory, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage-inventory.html#storage-inventory-contents">Amazon /// S3 Inventory lists</a> in the <i>Amazon S3 User Guide</i>. For more information about /// permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions /// related to bucket subresource operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Identity /// and access management in Amazon S3</a> in the <i>Amazon S3 User Guide</i>. /// </para> /// </dd> </dl> /// <para> /// <code>PutBucketInventoryConfiguration</code> has the following special errors: /// </para> /// <dl> <dt>HTTP 400 Bad Request Error</dt> <dd> /// <para> /// <i>Code:</i> InvalidArgument /// </para> /// /// <para> /// <i>Cause:</i> Invalid Argument /// </para> /// </dd> <dt>HTTP 400 Bad Request Error</dt> <dd> /// <para> /// <i>Code:</i> TooManyConfigurations /// </para> /// /// <para> /// <i>Cause:</i> You are attempting to create a new configuration but have already reached /// the 1,000-configuration limit. /// </para> /// </dd> <dt>HTTP 403 Forbidden Error</dt> <dd> /// <para> /// <i>Cause:</i> You are not the owner of the specified bucket, or you do not have the /// <code>s3:PutInventoryConfiguration</code> bucket permission to set the configuration /// on the bucket. /// </para> /// </dd> </dl> /// <para> /// The following operations are related to <code>PutBucketInventoryConfiguration</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketInventoryConfiguration.html">GetBucketInventoryConfiguration</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketInventoryConfiguration.html">DeleteBucketInventoryConfiguration</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketInventoryConfigurations.html">ListBucketInventoryConfigurations</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the PutBucketInventoryConfiguration service method.</param> /// /// <returns>The response from the PutBucketInventoryConfiguration service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketInventoryConfiguration">REST API Reference for PutBucketInventoryConfiguration Operation</seealso> PutBucketInventoryConfigurationResponse PutBucketInventoryConfiguration(PutBucketInventoryConfigurationRequest request); /// <summary> /// Initiates the asynchronous execution of the PutBucketInventoryConfiguration operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the PutBucketInventoryConfiguration operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketInventoryConfiguration /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketInventoryConfiguration">REST API Reference for PutBucketInventoryConfiguration Operation</seealso> IAsyncResult BeginPutBucketInventoryConfiguration(PutBucketInventoryConfigurationRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the PutBucketInventoryConfiguration operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginPutBucketInventoryConfiguration.</param> /// /// <returns>Returns a PutBucketInventoryConfigurationResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketInventoryConfiguration">REST API Reference for PutBucketInventoryConfiguration Operation</seealso> PutBucketInventoryConfigurationResponse EndPutBucketInventoryConfiguration(IAsyncResult asyncResult); #endregion #region PutBucketLogging /// <summary> /// 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. /// /// /// <para> /// The bucket owner is automatically granted FULL_CONTROL to all logs. You use the <code>Grantee</code> /// request element to grant access to other people. The <code>Permissions</code> request /// element specifies the kind of access the grantee has to the logs. /// </para> /// <important> /// <para> /// If the target bucket for log delivery uses the bucket owner enforced setting for S3 /// Object Ownership, you can't use the <code>Grantee</code> request element to grant /// access to others. Permissions can only be granted using policies. For more information, /// see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/enable-server-access-logging.html#grant-log-delivery-permissions-general">Permissions /// for server access log delivery</a> in the <i>Amazon S3 User Guide</i>. /// </para> /// </important> <dl> <dt>Grantee Values</dt> <dd> /// <para> /// You can specify the person (grantee) to whom you're assigning access rights (by using /// request elements) in the following ways: /// </para> /// <ul> <li> /// <para> /// By the person's ID: /// </para> /// /// <para> /// <code><Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> /// </Grantee></code> /// </para> /// /// <para> /// <code>DisplayName</code> is optional and ignored in the request. /// </para> /// </li> <li> /// <para> /// By Email address: /// </para> /// /// <para> /// <code> <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress></Grantee></code> /// /// </para> /// /// <para> /// The grantee is resolved to the <code>CanonicalUser</code> and, in a response to a /// <code>GETObjectAcl</code> request, appears as the CanonicalUser. /// </para> /// </li> <li> /// <para> /// By URI: /// </para> /// /// <para> /// <code><Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee></code> /// /// </para> /// </li> </ul> </dd> </dl> /// <para> /// To enable logging, you use <code>LoggingEnabled</code> and its children request elements. /// To disable logging, you use an empty <code>BucketLoggingStatus</code> request element: /// </para> /// /// <para> /// <code><BucketLoggingStatus xmlns="http://doc.s3.amazonaws.com/2006-03-01" /></code> /// /// </para> /// /// <para> /// For more information about server access logging, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerLogs.html">Server /// Access Logging</a> in the <i>Amazon S3 User Guide</i>. /// </para> /// /// <para> /// For more information about creating a bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a>. /// For more information about returning the logging status of a bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLogging.html">GetBucketLogging</a>. /// </para> /// /// <para> /// The following operations are related to <code>PutBucketLogging</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html">PutObject</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html">DeleteBucket</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLogging.html">GetBucketLogging</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the PutBucketLogging service method.</param> /// /// <returns>The response from the PutBucketLogging service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketLogging">REST API Reference for PutBucketLogging Operation</seealso> PutBucketLoggingResponse PutBucketLogging(PutBucketLoggingRequest request); /// <summary> /// Initiates the asynchronous execution of the PutBucketLogging operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the PutBucketLogging operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketLogging /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketLogging">REST API Reference for PutBucketLogging Operation</seealso> IAsyncResult BeginPutBucketLogging(PutBucketLoggingRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the PutBucketLogging operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginPutBucketLogging.</param> /// /// <returns>Returns a PutBucketLoggingResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketLogging">REST API Reference for PutBucketLogging Operation</seealso> PutBucketLoggingResponse EndPutBucketLogging(IAsyncResult asyncResult); #endregion #region PutBucketMetricsConfiguration /// <summary> /// 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. /// /// /// <para> /// To use this operation, you must have permissions to perform the <code>s3:PutMetricsConfiguration</code> /// action. The bucket owner has this permission by default. The bucket owner can grant /// this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions /// Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing /// Access Permissions to Your Amazon S3 Resources</a>. /// </para> /// /// <para> /// For information about CloudWatch request metrics for Amazon S3, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html">Monitoring /// Metrics with Amazon CloudWatch</a>. /// </para> /// /// <para> /// The following operations are related to <code>PutBucketMetricsConfiguration</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetricsConfiguration.html">DeleteBucketMetricsConfiguration</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketMetricsConfiguration.html">GetBucketMetricsConfiguration</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketMetricsConfigurations.html">ListBucketMetricsConfigurations</a> /// /// </para> /// </li> </ul> /// <para> /// <code>PutBucketMetricsConfiguration</code> has the following special error: /// </para> /// <ul> <li> /// <para> /// Error code: <code>TooManyConfigurations</code> /// </para> /// <ul> <li> /// <para> /// Description: You are attempting to create a new configuration but have already reached /// the 1,000-configuration limit. /// </para> /// </li> <li> /// <para> /// HTTP Status Code: HTTP 400 Bad Request /// </para> /// </li> </ul> </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the PutBucketMetricsConfiguration service method.</param> /// /// <returns>The response from the PutBucketMetricsConfiguration service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketMetricsConfiguration">REST API Reference for PutBucketMetricsConfiguration Operation</seealso> PutBucketMetricsConfigurationResponse PutBucketMetricsConfiguration(PutBucketMetricsConfigurationRequest request); /// <summary> /// Initiates the asynchronous execution of the PutBucketMetricsConfiguration operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the PutBucketMetricsConfiguration operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketMetricsConfiguration /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketMetricsConfiguration">REST API Reference for PutBucketMetricsConfiguration Operation</seealso> IAsyncResult BeginPutBucketMetricsConfiguration(PutBucketMetricsConfigurationRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the PutBucketMetricsConfiguration operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginPutBucketMetricsConfiguration.</param> /// /// <returns>Returns a PutBucketMetricsConfigurationResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketMetricsConfiguration">REST API Reference for PutBucketMetricsConfiguration Operation</seealso> PutBucketMetricsConfigurationResponse EndPutBucketMetricsConfiguration(IAsyncResult asyncResult); #endregion #region PutBucketNotification /// <summary> /// Enables notifications of specified events for a bucket. For more information about /// event notifications, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html">Configuring /// Event Notifications</a>. /// /// /// <para> /// 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. /// </para> /// /// <para> /// By default, your bucket has no event notifications configured. That is, the notification /// configuration will be an empty <code>NotificationConfiguration</code>. /// </para> /// /// <para> /// <code><NotificationConfiguration></code> /// </para> /// /// <para> /// <code></NotificationConfiguration></code> /// </para> /// /// <para> /// This action replaces the existing notification configuration with the configuration /// you include in the request body. /// </para> /// /// <para> /// 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html">Configuring /// Notifications for Amazon S3 Events</a>. /// </para> /// /// <para> /// You can disable notifications by adding the empty NotificationConfiguration element. /// </para> /// /// <para> /// For more information about the number of event notification configurations that you /// can create per bucket, see <a href="https://docs.aws.amazon.com/general/latest/gr/s3.html#limits_s3">Amazon /// S3 service quotas</a> in <i>Amazon Web Services General Reference</i>. /// </para> /// /// <para> /// By default, only the bucket owner can configure notifications on a bucket. However, /// bucket owners can use a bucket policy to grant permission to other users to set this /// configuration with the required <code>s3:PutBucketNotification</code> permission. /// </para> /// <note> /// <para> /// 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. /// </para> /// </note> /// <para> /// If the configuration in the request body includes only one <code>TopicConfiguration</code> /// specifying only the <code>s3:ReducedRedundancyLostObject</code> event type, the response /// will also include the <code>x-amz-sns-test-message-id</code> header containing the /// message ID of the test notification sent to the topic. /// </para> /// /// <para> /// The following action is related to <code>PutBucketNotificationConfiguration</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketNotificationConfiguration.html">GetBucketNotificationConfiguration</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the PutBucketNotification service method.</param> /// /// <returns>The response from the PutBucketNotification service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketNotificationConfiguration">REST API Reference for PutBucketNotification Operation</seealso> PutBucketNotificationResponse PutBucketNotification(PutBucketNotificationRequest request); /// <summary> /// Initiates the asynchronous execution of the PutBucketNotification operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the PutBucketNotification operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketNotification /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketNotificationConfiguration">REST API Reference for PutBucketNotification Operation</seealso> IAsyncResult BeginPutBucketNotification(PutBucketNotificationRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the PutBucketNotification operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginPutBucketNotification.</param> /// /// <returns>Returns a PutBucketNotificationResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketNotificationConfiguration">REST API Reference for PutBucketNotification Operation</seealso> PutBucketNotificationResponse EndPutBucketNotification(IAsyncResult asyncResult); #endregion #region PutBucketOwnershipControls /// <summary> /// Creates or modifies <code>OwnershipControls</code> for an Amazon S3 bucket. To use /// this operation, you must have the <code>s3:PutBucketOwnershipControls</code> permission. /// For more information about Amazon S3 permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/user-guide/using-with-s3-actions.html">Specifying /// permissions in a policy</a>. /// /// /// <para> /// For information about Amazon S3 Object Ownership, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/user-guide/about-object-ownership.html">Using /// object ownership</a>. /// </para> /// /// <para> /// The following operations are related to <code>PutBucketOwnershipControls</code>: /// </para> /// <ul> <li> /// <para> /// <a>GetBucketOwnershipControls</a> /// </para> /// </li> <li> /// <para> /// <a>DeleteBucketOwnershipControls</a> /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the PutBucketOwnershipControls service method.</param> /// /// <returns>The response from the PutBucketOwnershipControls service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketOwnershipControls">REST API Reference for PutBucketOwnershipControls Operation</seealso> PutBucketOwnershipControlsResponse PutBucketOwnershipControls(PutBucketOwnershipControlsRequest request); /// <summary> /// Initiates the asynchronous execution of the PutBucketOwnershipControls operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the PutBucketOwnershipControls operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketOwnershipControls /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketOwnershipControls">REST API Reference for PutBucketOwnershipControls Operation</seealso> IAsyncResult BeginPutBucketOwnershipControls(PutBucketOwnershipControlsRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the PutBucketOwnershipControls operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginPutBucketOwnershipControls.</param> /// /// <returns>Returns a PutBucketOwnershipControlsResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketOwnershipControls">REST API Reference for PutBucketOwnershipControls Operation</seealso> PutBucketOwnershipControlsResponse EndPutBucketOwnershipControls(IAsyncResult asyncResult); #endregion #region PutBucketPolicy /// <summary> /// 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 <code>PutBucketPolicy</code> permissions on the /// specified bucket and belong to the bucket owner's account in order to use this operation. /// /// /// <para> /// If you don't have <code>PutBucketPolicy</code> permissions, Amazon S3 returns a <code>403 /// Access Denied</code> 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 <code>405 /// Method Not Allowed</code> error. /// </para> /// <important> /// <para> /// To ensure that bucket owners don't inadvertently lock themselves out of their own /// buckets, the root principal in a bucket owner's Amazon Web Services account can perform /// the <code>GetBucketPolicy</code>, <code>PutBucketPolicy</code>, and <code>DeleteBucketPolicy</code> /// API actions, even if their bucket policy explicitly denies the root principal's access. /// Bucket owner root principals can only be blocked from performing these API actions /// by VPC endpoint policies and Amazon Web Services Organizations policies. /// </para> /// </important> /// <para> /// For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html">Bucket /// policy examples</a>. /// </para> /// /// <para> /// The following operations are related to <code>PutBucketPolicy</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html">DeleteBucket</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="bucketName">The name of the bucket.</param> /// <param name="policy">The bucket policy as a JSON document.</param> /// /// <returns>The response from the PutBucketPolicy service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketPolicy">REST API Reference for PutBucketPolicy Operation</seealso> PutBucketPolicyResponse PutBucketPolicy(string bucketName, string policy); /// <summary> /// 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 <code>PutBucketPolicy</code> permissions on the /// specified bucket and belong to the bucket owner's account in order to use this operation. /// /// /// <para> /// If you don't have <code>PutBucketPolicy</code> permissions, Amazon S3 returns a <code>403 /// Access Denied</code> 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 <code>405 /// Method Not Allowed</code> error. /// </para> /// <important> /// <para> /// To ensure that bucket owners don't inadvertently lock themselves out of their own /// buckets, the root principal in a bucket owner's Amazon Web Services account can perform /// the <code>GetBucketPolicy</code>, <code>PutBucketPolicy</code>, and <code>DeleteBucketPolicy</code> /// API actions, even if their bucket policy explicitly denies the root principal's access. /// Bucket owner root principals can only be blocked from performing these API actions /// by VPC endpoint policies and Amazon Web Services Organizations policies. /// </para> /// </important> /// <para> /// For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html">Bucket /// policy examples</a>. /// </para> /// /// <para> /// The following operations are related to <code>PutBucketPolicy</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html">DeleteBucket</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="bucketName">The name of the bucket.</param> /// <param name="policy">The bucket policy as a JSON document.</param> /// <param name="contentMD5">The MD5 hash of the request body. For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</param> /// /// <returns>The response from the PutBucketPolicy service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketPolicy">REST API Reference for PutBucketPolicy Operation</seealso> PutBucketPolicyResponse PutBucketPolicy(string bucketName, string policy, string contentMD5); /// <summary> /// 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 <code>PutBucketPolicy</code> permissions on the /// specified bucket and belong to the bucket owner's account in order to use this operation. /// /// /// <para> /// If you don't have <code>PutBucketPolicy</code> permissions, Amazon S3 returns a <code>403 /// Access Denied</code> 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 <code>405 /// Method Not Allowed</code> error. /// </para> /// <important> /// <para> /// To ensure that bucket owners don't inadvertently lock themselves out of their own /// buckets, the root principal in a bucket owner's Amazon Web Services account can perform /// the <code>GetBucketPolicy</code>, <code>PutBucketPolicy</code>, and <code>DeleteBucketPolicy</code> /// API actions, even if their bucket policy explicitly denies the root principal's access. /// Bucket owner root principals can only be blocked from performing these API actions /// by VPC endpoint policies and Amazon Web Services Organizations policies. /// </para> /// </important> /// <para> /// For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html">Bucket /// policy examples</a>. /// </para> /// /// <para> /// The following operations are related to <code>PutBucketPolicy</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html">DeleteBucket</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the PutBucketPolicy service method.</param> /// /// <returns>The response from the PutBucketPolicy service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketPolicy">REST API Reference for PutBucketPolicy Operation</seealso> PutBucketPolicyResponse PutBucketPolicy(PutBucketPolicyRequest request); /// <summary> /// Initiates the asynchronous execution of the PutBucketPolicy operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the PutBucketPolicy operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketPolicy /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketPolicy">REST API Reference for PutBucketPolicy Operation</seealso> IAsyncResult BeginPutBucketPolicy(PutBucketPolicyRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the PutBucketPolicy operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginPutBucketPolicy.</param> /// /// <returns>Returns a PutBucketPolicyResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketPolicy">REST API Reference for PutBucketPolicy Operation</seealso> PutBucketPolicyResponse EndPutBucketPolicy(IAsyncResult asyncResult); #endregion #region PutBucketReplication /// <summary> /// Creates a replication configuration or replaces an existing one. For more information, /// see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html">Replication</a> /// in the <i>Amazon S3 User Guide</i>. /// /// /// <para> /// 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. /// </para> /// /// <para> /// 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. /// </para> /// /// <para> /// 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: <code>DeleteMarkerReplication</code>, /// <code>Status</code>, and <code>Priority</code>. /// </para> /// <note> /// <para> /// If you are using an earlier version of the replication configuration, Amazon S3 handles /// replication of delete markers differently. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-backward-compat-considerations">Backward /// Compatibility</a>. /// </para> /// </note> /// <para> /// For information about enabling versioning on a bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html">Using /// Versioning</a>. /// </para> /// <dl> <dt>Handling Replication of Encrypted Objects</dt> <dd> /// <para> /// 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: <code>SourceSelectionCriteria</code>, <code>SseKmsEncryptedObjects</code>, /// <code>Status</code>, <code>EncryptionConfiguration</code>, and <code>ReplicaKmsKeyID</code>. /// For information about replication configuration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-config-for-kms-objects.html">Replicating /// Objects Created with SSE Using KMS keys</a>. /// </para> /// /// <para> /// For information on <code>PutBucketReplication</code> errors, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ReplicationErrorCodeList">List /// of replication-related error codes</a> /// </para> /// </dd> <dt>Permissions</dt> <dd> /// <para> /// To create a <code>PutBucketReplication</code> request, you must have <code>s3:PutReplicationConfiguration</code> /// permissions for the bucket. /// </para> /// /// <para> /// 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying /// Permissions in a Policy</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing /// Access Permissions to Your Amazon S3 Resources</a>. /// </para> /// <note> /// <para> /// To perform this operation, the user or role performing the action must have the <a /// href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html">iam:PassRole</a> /// permission. /// </para> /// </note> </dd> </dl> /// <para> /// The following operations are related to <code>PutBucketReplication</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketReplication.html">GetBucketReplication</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketReplication.html">DeleteBucketReplication</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the PutBucketReplication service method.</param> /// /// <returns>The response from the PutBucketReplication service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketReplication">REST API Reference for PutBucketReplication Operation</seealso> PutBucketReplicationResponse PutBucketReplication(PutBucketReplicationRequest request); /// <summary> /// Initiates the asynchronous execution of the PutBucketReplication operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the PutBucketReplication operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketReplication /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketReplication">REST API Reference for PutBucketReplication Operation</seealso> IAsyncResult BeginPutBucketReplication(PutBucketReplicationRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the PutBucketReplication operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginPutBucketReplication.</param> /// /// <returns>Returns a PutBucketReplicationResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketReplication">REST API Reference for PutBucketReplication Operation</seealso> PutBucketReplicationResponse EndPutBucketReplication(IAsyncResult asyncResult); #endregion #region PutBucketRequestPayment /// <summary> /// 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html">Requester /// Pays Buckets</a>. /// /// /// <para> /// The following operations are related to <code>PutBucketRequestPayment</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketRequestPayment.html">GetBucketRequestPayment</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="bucketName">The bucket name.</param> /// <param name="requestPaymentConfiguration">Container for Payer.</param> /// /// <returns>The response from the PutBucketRequestPayment service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketRequestPayment">REST API Reference for PutBucketRequestPayment Operation</seealso> PutBucketRequestPaymentResponse PutBucketRequestPayment(string bucketName, RequestPaymentConfiguration requestPaymentConfiguration); /// <summary> /// 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html">Requester /// Pays Buckets</a>. /// /// /// <para> /// The following operations are related to <code>PutBucketRequestPayment</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketRequestPayment.html">GetBucketRequestPayment</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the PutBucketRequestPayment service method.</param> /// /// <returns>The response from the PutBucketRequestPayment service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketRequestPayment">REST API Reference for PutBucketRequestPayment Operation</seealso> PutBucketRequestPaymentResponse PutBucketRequestPayment(PutBucketRequestPaymentRequest request); /// <summary> /// Initiates the asynchronous execution of the PutBucketRequestPayment operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the PutBucketRequestPayment operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketRequestPayment /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketRequestPayment">REST API Reference for PutBucketRequestPayment Operation</seealso> IAsyncResult BeginPutBucketRequestPayment(PutBucketRequestPaymentRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the PutBucketRequestPayment operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginPutBucketRequestPayment.</param> /// /// <returns>Returns a PutBucketRequestPaymentResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketRequestPayment">REST API Reference for PutBucketRequestPayment Operation</seealso> PutBucketRequestPaymentResponse EndPutBucketRequestPayment(IAsyncResult asyncResult); #endregion #region PutBucketTagging /// <summary> /// Sets the tags for a bucket. /// /// /// <para> /// 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 <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html">Cost /// Allocation and Tagging</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/CostAllocTagging.html">Using /// Cost Allocation in Amazon S3 Bucket Tags</a>. /// </para> /// <note> /// <para> /// 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. /// </para> /// </note> /// <para> /// To use this operation, you must have permissions to perform the <code>s3:PutBucketTagging</code> /// action. The bucket owner has this permission by default and can grant this permission /// to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions /// Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing /// Access Permissions to Your Amazon S3 Resources</a>. /// </para> /// /// <para> /// <code>PutBucketTagging</code> has the following special errors: /// </para> /// <ul> <li> /// <para> /// Error code: <code>InvalidTagError</code> /// </para> /// <ul> <li> /// <para> /// 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 <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html">User-Defined /// Tag Restrictions</a> and <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/aws-tag-restrictions.html">Amazon /// Web Services-Generated Cost Allocation Tag Restrictions</a>. /// </para> /// </li> </ul> </li> <li> /// <para> /// Error code: <code>MalformedXMLError</code> /// </para> /// <ul> <li> /// <para> /// Description: The XML provided does not match the schema. /// </para> /// </li> </ul> </li> <li> /// <para> /// Error code: <code>OperationAbortedError </code> /// </para> /// <ul> <li> /// <para> /// Description: A conflicting conditional action is currently in progress against this /// resource. Please try again. /// </para> /// </li> </ul> </li> <li> /// <para> /// Error code: <code>InternalError</code> /// </para> /// <ul> <li> /// <para> /// Description: The service was unable to apply the provided tag to the bucket. /// </para> /// </li> </ul> </li> </ul> /// <para> /// The following operations are related to <code>PutBucketTagging</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketTagging.html">GetBucketTagging</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketTagging.html">DeleteBucketTagging</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="bucketName">The bucket name.</param> /// <param name="tagSet">A property of PutBucketTaggingRequest used to execute the PutBucketTagging service method.</param> /// /// <returns>The response from the PutBucketTagging service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketTagging">REST API Reference for PutBucketTagging Operation</seealso> PutBucketTaggingResponse PutBucketTagging(string bucketName, List<Tag> tagSet); /// <summary> /// Sets the tags for a bucket. /// /// /// <para> /// 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 <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html">Cost /// Allocation and Tagging</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/CostAllocTagging.html">Using /// Cost Allocation in Amazon S3 Bucket Tags</a>. /// </para> /// <note> /// <para> /// 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. /// </para> /// </note> /// <para> /// To use this operation, you must have permissions to perform the <code>s3:PutBucketTagging</code> /// action. The bucket owner has this permission by default and can grant this permission /// to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions /// Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing /// Access Permissions to Your Amazon S3 Resources</a>. /// </para> /// /// <para> /// <code>PutBucketTagging</code> has the following special errors: /// </para> /// <ul> <li> /// <para> /// Error code: <code>InvalidTagError</code> /// </para> /// <ul> <li> /// <para> /// 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 <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html">User-Defined /// Tag Restrictions</a> and <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/aws-tag-restrictions.html">Amazon /// Web Services-Generated Cost Allocation Tag Restrictions</a>. /// </para> /// </li> </ul> </li> <li> /// <para> /// Error code: <code>MalformedXMLError</code> /// </para> /// <ul> <li> /// <para> /// Description: The XML provided does not match the schema. /// </para> /// </li> </ul> </li> <li> /// <para> /// Error code: <code>OperationAbortedError </code> /// </para> /// <ul> <li> /// <para> /// Description: A conflicting conditional action is currently in progress against this /// resource. Please try again. /// </para> /// </li> </ul> </li> <li> /// <para> /// Error code: <code>InternalError</code> /// </para> /// <ul> <li> /// <para> /// Description: The service was unable to apply the provided tag to the bucket. /// </para> /// </li> </ul> </li> </ul> /// <para> /// The following operations are related to <code>PutBucketTagging</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketTagging.html">GetBucketTagging</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketTagging.html">DeleteBucketTagging</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the PutBucketTagging service method.</param> /// /// <returns>The response from the PutBucketTagging service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketTagging">REST API Reference for PutBucketTagging Operation</seealso> PutBucketTaggingResponse PutBucketTagging(PutBucketTaggingRequest request); /// <summary> /// Initiates the asynchronous execution of the PutBucketTagging operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the PutBucketTagging operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketTagging /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketTagging">REST API Reference for PutBucketTagging Operation</seealso> IAsyncResult BeginPutBucketTagging(PutBucketTaggingRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the PutBucketTagging operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginPutBucketTagging.</param> /// /// <returns>Returns a PutBucketTaggingResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketTagging">REST API Reference for PutBucketTagging Operation</seealso> PutBucketTaggingResponse EndPutBucketTagging(IAsyncResult asyncResult); #endregion #region PutBucketVersioning /// <summary> /// Sets the versioning state of an existing bucket. /// /// /// <para> /// You can set the versioning state with one of the following values: /// </para> /// /// <para> /// <b>Enabled</b>—Enables versioning for the objects in the bucket. All objects added /// to the bucket receive a unique version ID. /// </para> /// /// <para> /// <b>Suspended</b>—Disables versioning for the objects in the bucket. All objects added /// to the bucket receive the version ID null. /// </para> /// /// <para> /// If the versioning state has never been set on a bucket, it has no versioning state; /// a <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html">GetBucketVersioning</a> /// request does not return a versioning state value. /// </para> /// /// <para> /// 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 <code>x-amz-mfa request</code> header and the <code>Status</code> and /// the <code>MfaDelete</code> request elements in a request to set the versioning state /// of the bucket. /// </para> /// <important> /// <para> /// If you have an object expiration lifecycle configuration in your non-versioned bucket /// and you want to maintain the same permanent delete behavior when you enable versioning, /// you must add a noncurrent expiration policy. The noncurrent expiration lifecycle configuration /// will manage the deletes of the noncurrent object versions in the version-enabled bucket. /// (A version-enabled bucket maintains one current and zero or more noncurrent object /// versions.) For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html#lifecycle-and-other-bucket-config">Lifecycle /// and Versioning</a>. /// </para> /// </important> /// <para> /// The following operations are related to <code>PutBucketVersioning</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html">DeleteBucket</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html">GetBucketVersioning</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the PutBucketVersioning service method.</param> /// /// <returns>The response from the PutBucketVersioning service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketVersioning">REST API Reference for PutBucketVersioning Operation</seealso> PutBucketVersioningResponse PutBucketVersioning(PutBucketVersioningRequest request); /// <summary> /// Initiates the asynchronous execution of the PutBucketVersioning operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the PutBucketVersioning operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketVersioning /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketVersioning">REST API Reference for PutBucketVersioning Operation</seealso> IAsyncResult BeginPutBucketVersioning(PutBucketVersioningRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the PutBucketVersioning operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginPutBucketVersioning.</param> /// /// <returns>Returns a PutBucketVersioningResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketVersioning">REST API Reference for PutBucketVersioning Operation</seealso> PutBucketVersioningResponse EndPutBucketVersioning(IAsyncResult asyncResult); #endregion #region PutBucketWebsite /// <summary> /// Sets the configuration of the website that is specified in the <code>website</code> /// 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html">Hosting /// Websites on Amazon S3</a>. /// /// /// <para> /// This PUT action requires the <code>S3:PutBucketWebsite</code> 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 <code>S3:PutBucketWebsite</code> permission. /// </para> /// /// <para> /// 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. /// </para> /// <ul> <li> /// <para> /// <code>WebsiteConfiguration</code> /// </para> /// </li> <li> /// <para> /// <code>RedirectAllRequestsTo</code> /// </para> /// </li> <li> /// <para> /// <code>HostName</code> /// </para> /// </li> <li> /// <para> /// <code>Protocol</code> /// </para> /// </li> </ul> /// <para> /// 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. /// </para> /// <ul> <li> /// <para> /// <code>WebsiteConfiguration</code> /// </para> /// </li> <li> /// <para> /// <code>IndexDocument</code> /// </para> /// </li> <li> /// <para> /// <code>Suffix</code> /// </para> /// </li> <li> /// <para> /// <code>ErrorDocument</code> /// </para> /// </li> <li> /// <para> /// <code>Key</code> /// </para> /// </li> <li> /// <para> /// <code>RoutingRules</code> /// </para> /// </li> <li> /// <para> /// <code>RoutingRule</code> /// </para> /// </li> <li> /// <para> /// <code>Condition</code> /// </para> /// </li> <li> /// <para> /// <code>HttpErrorCodeReturnedEquals</code> /// </para> /// </li> <li> /// <para> /// <code>KeyPrefixEquals</code> /// </para> /// </li> <li> /// <para> /// <code>Redirect</code> /// </para> /// </li> <li> /// <para> /// <code>Protocol</code> /// </para> /// </li> <li> /// <para> /// <code>HostName</code> /// </para> /// </li> <li> /// <para> /// <code>ReplaceKeyPrefixWith</code> /// </para> /// </li> <li> /// <para> /// <code>ReplaceKeyWith</code> /// </para> /// </li> <li> /// <para> /// <code>HttpRedirectCode</code> /// </para> /// </li> </ul> /// <para> /// 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 /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html">Configuring /// an Object Redirect</a> in the <i>Amazon S3 User Guide</i>. /// </para> /// </summary> /// <param name="bucketName">The bucket name.</param> /// <param name="websiteConfiguration">Container for the request.</param> /// /// <returns>The response from the PutBucketWebsite service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketWebsite">REST API Reference for PutBucketWebsite Operation</seealso> PutBucketWebsiteResponse PutBucketWebsite(string bucketName, WebsiteConfiguration websiteConfiguration); /// <summary> /// Sets the configuration of the website that is specified in the <code>website</code> /// 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html">Hosting /// Websites on Amazon S3</a>. /// /// /// <para> /// This PUT action requires the <code>S3:PutBucketWebsite</code> 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 <code>S3:PutBucketWebsite</code> permission. /// </para> /// /// <para> /// 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. /// </para> /// <ul> <li> /// <para> /// <code>WebsiteConfiguration</code> /// </para> /// </li> <li> /// <para> /// <code>RedirectAllRequestsTo</code> /// </para> /// </li> <li> /// <para> /// <code>HostName</code> /// </para> /// </li> <li> /// <para> /// <code>Protocol</code> /// </para> /// </li> </ul> /// <para> /// 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. /// </para> /// <ul> <li> /// <para> /// <code>WebsiteConfiguration</code> /// </para> /// </li> <li> /// <para> /// <code>IndexDocument</code> /// </para> /// </li> <li> /// <para> /// <code>Suffix</code> /// </para> /// </li> <li> /// <para> /// <code>ErrorDocument</code> /// </para> /// </li> <li> /// <para> /// <code>Key</code> /// </para> /// </li> <li> /// <para> /// <code>RoutingRules</code> /// </para> /// </li> <li> /// <para> /// <code>RoutingRule</code> /// </para> /// </li> <li> /// <para> /// <code>Condition</code> /// </para> /// </li> <li> /// <para> /// <code>HttpErrorCodeReturnedEquals</code> /// </para> /// </li> <li> /// <para> /// <code>KeyPrefixEquals</code> /// </para> /// </li> <li> /// <para> /// <code>Redirect</code> /// </para> /// </li> <li> /// <para> /// <code>Protocol</code> /// </para> /// </li> <li> /// <para> /// <code>HostName</code> /// </para> /// </li> <li> /// <para> /// <code>ReplaceKeyPrefixWith</code> /// </para> /// </li> <li> /// <para> /// <code>ReplaceKeyWith</code> /// </para> /// </li> <li> /// <para> /// <code>HttpRedirectCode</code> /// </para> /// </li> </ul> /// <para> /// 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 /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html">Configuring /// an Object Redirect</a> in the <i>Amazon S3 User Guide</i>. /// </para> /// </summary> /// <param name="request">Container for the necessary parameters to execute the PutBucketWebsite service method.</param> /// /// <returns>The response from the PutBucketWebsite service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketWebsite">REST API Reference for PutBucketWebsite Operation</seealso> PutBucketWebsiteResponse PutBucketWebsite(PutBucketWebsiteRequest request); /// <summary> /// Initiates the asynchronous execution of the PutBucketWebsite operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the PutBucketWebsite operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketWebsite /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketWebsite">REST API Reference for PutBucketWebsite Operation</seealso> IAsyncResult BeginPutBucketWebsite(PutBucketWebsiteRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the PutBucketWebsite operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginPutBucketWebsite.</param> /// /// <returns>Returns a PutBucketWebsiteResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketWebsite">REST API Reference for PutBucketWebsite Operation</seealso> PutBucketWebsiteResponse EndPutBucketWebsite(IAsyncResult asyncResult); #endregion #region PutCORSConfiguration /// <summary> /// Sets the <code>cors</code> configuration for your bucket. If the configuration exists, /// Amazon S3 replaces it. /// /// /// <para> /// To use this operation, you must be allowed to perform the <code>s3:PutBucketCORS</code> /// action. By default, the bucket owner has this permission and can grant it to others. /// </para> /// /// <para> /// 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 <code>http://www.example.com</code> /// to access your Amazon S3 bucket at <code>my.example.bucket.com</code> by using the /// browser's <code>XMLHttpRequest</code> capability. /// </para> /// /// <para> /// To enable cross-origin resource sharing (CORS) on a bucket, you add the <code>cors</code> /// subresource to the bucket. The <code>cors</code> 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. /// </para> /// /// <para> /// When Amazon S3 receives a cross-origin request (or a pre-flight OPTIONS request) against /// a bucket, it evaluates the <code>cors</code> configuration on the bucket and uses /// the first <code>CORSRule</code> rule that matches the incoming browser request to /// enable a cross-origin request. For a rule to match, the following conditions must /// be met: /// </para> /// <ul> <li> /// <para> /// The request's <code>Origin</code> header must match <code>AllowedOrigin</code> elements. /// </para> /// </li> <li> /// <para> /// The request method (for example, GET, PUT, HEAD, and so on) or the <code>Access-Control-Request-Method</code> /// header in case of a pre-flight <code>OPTIONS</code> request must be one of the <code>AllowedMethod</code> /// elements. /// </para> /// </li> <li> /// <para> /// Every header specified in the <code>Access-Control-Request-Headers</code> request /// header of a pre-flight request must match an <code>AllowedHeader</code> element. /// </para> /// </li> </ul> /// <para> /// For more information about CORS, go to <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html">Enabling /// Cross-Origin Resource Sharing</a> in the <i>Amazon S3 User Guide</i>. /// </para> /// /// <para> /// The following operations are related to <code>PutBucketCors</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketCors.html">GetBucketCors</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketCors.html">DeleteBucketCors</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTOPTIONSobject.html">RESTOPTIONSobject</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="bucketName">Specifies the bucket impacted by the <code>cors</code>configuration.</param> /// <param name="configuration">Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html">Enabling Cross-Origin Resource Sharing</a> in the <i>Amazon S3 User Guide</i>.</param> /// /// <returns>The response from the PutCORSConfiguration service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketCors">REST API Reference for PutCORSConfiguration Operation</seealso> PutCORSConfigurationResponse PutCORSConfiguration(string bucketName, CORSConfiguration configuration); /// <summary> /// Sets the <code>cors</code> configuration for your bucket. If the configuration exists, /// Amazon S3 replaces it. /// /// /// <para> /// To use this operation, you must be allowed to perform the <code>s3:PutBucketCORS</code> /// action. By default, the bucket owner has this permission and can grant it to others. /// </para> /// /// <para> /// 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 <code>http://www.example.com</code> /// to access your Amazon S3 bucket at <code>my.example.bucket.com</code> by using the /// browser's <code>XMLHttpRequest</code> capability. /// </para> /// /// <para> /// To enable cross-origin resource sharing (CORS) on a bucket, you add the <code>cors</code> /// subresource to the bucket. The <code>cors</code> 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. /// </para> /// /// <para> /// When Amazon S3 receives a cross-origin request (or a pre-flight OPTIONS request) against /// a bucket, it evaluates the <code>cors</code> configuration on the bucket and uses /// the first <code>CORSRule</code> rule that matches the incoming browser request to /// enable a cross-origin request. For a rule to match, the following conditions must /// be met: /// </para> /// <ul> <li> /// <para> /// The request's <code>Origin</code> header must match <code>AllowedOrigin</code> elements. /// </para> /// </li> <li> /// <para> /// The request method (for example, GET, PUT, HEAD, and so on) or the <code>Access-Control-Request-Method</code> /// header in case of a pre-flight <code>OPTIONS</code> request must be one of the <code>AllowedMethod</code> /// elements. /// </para> /// </li> <li> /// <para> /// Every header specified in the <code>Access-Control-Request-Headers</code> request /// header of a pre-flight request must match an <code>AllowedHeader</code> element. /// </para> /// </li> </ul> /// <para> /// For more information about CORS, go to <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html">Enabling /// Cross-Origin Resource Sharing</a> in the <i>Amazon S3 User Guide</i>. /// </para> /// /// <para> /// The following operations are related to <code>PutBucketCors</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketCors.html">GetBucketCors</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketCors.html">DeleteBucketCors</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTOPTIONSobject.html">RESTOPTIONSobject</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the PutCORSConfiguration service method.</param> /// /// <returns>The response from the PutCORSConfiguration service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketCors">REST API Reference for PutCORSConfiguration Operation</seealso> PutCORSConfigurationResponse PutCORSConfiguration(PutCORSConfigurationRequest request); /// <summary> /// Initiates the asynchronous execution of the PutCORSConfiguration operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the PutCORSConfiguration operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutCORSConfiguration /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketCors">REST API Reference for PutCORSConfiguration Operation</seealso> IAsyncResult BeginPutCORSConfiguration(PutCORSConfigurationRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the PutCORSConfiguration operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginPutCORSConfiguration.</param> /// /// <returns>Returns a PutCORSConfigurationResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketCors">REST API Reference for PutCORSConfiguration Operation</seealso> PutCORSConfigurationResponse EndPutCORSConfiguration(IAsyncResult asyncResult); #endregion #region PutLifecycleConfiguration /// <summary> /// 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lifecycle-mgmt.html">Managing /// your storage lifecycle</a>. /// /// <note> /// <para> /// 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html">PutBucketLifecycle</a>. /// </para> /// </note> <dl> <dt>Rules</dt> <dd> /// <para> /// 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: /// </para> /// <ul> <li> /// <para> /// A 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. /// </para> /// </li> <li> /// <para> /// A status indicating whether the rule is in effect. /// </para> /// </li> <li> /// <para> /// 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. /// </para> /// </li> </ul> /// <para> /// For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html">Object /// Lifecycle Management</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html">Lifecycle /// Configuration Elements</a>. /// </para> /// </dd> <dt>Permissions</dt> <dd> /// <para> /// 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 <code>s3:PutLifecycleConfiguration</code> /// permission. /// </para> /// /// <para> /// You can also explicitly deny permissions. An 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: /// </para> /// <ul> <li> /// <para> /// <code>s3:DeleteObject</code> /// </para> /// </li> <li> /// <para> /// <code>s3:DeleteObjectVersion</code> /// </para> /// </li> <li> /// <para> /// <code>s3:PutLifecycleConfiguration</code> /// </para> /// </li> </ul> /// <para> /// For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing /// Access Permissions to Your Amazon S3 Resources</a>. /// </para> /// </dd> </dl> /// <para> /// The following operations are related to <code>PutBucketLifecycleConfiguration</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/lifecycle-configuration-examples.html">Examples /// of Lifecycle Configuration</a> /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html">GetBucketLifecycleConfiguration</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html">DeleteBucketLifecycle</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="bucketName">The name of the bucket for which to set the configuration.</param> /// <param name="configuration">A property of PutLifecycleConfigurationRequest used to execute the PutLifecycleConfiguration service method.</param> /// /// <returns>The response from the PutLifecycleConfiguration service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketLifecycleConfiguration">REST API Reference for PutLifecycleConfiguration Operation</seealso> PutLifecycleConfigurationResponse PutLifecycleConfiguration(string bucketName, LifecycleConfiguration configuration); /// <summary> /// 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lifecycle-mgmt.html">Managing /// your storage lifecycle</a>. /// /// <note> /// <para> /// 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html">PutBucketLifecycle</a>. /// </para> /// </note> <dl> <dt>Rules</dt> <dd> /// <para> /// 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: /// </para> /// <ul> <li> /// <para> /// A 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. /// </para> /// </li> <li> /// <para> /// A status indicating whether the rule is in effect. /// </para> /// </li> <li> /// <para> /// 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. /// </para> /// </li> </ul> /// <para> /// For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html">Object /// Lifecycle Management</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html">Lifecycle /// Configuration Elements</a>. /// </para> /// </dd> <dt>Permissions</dt> <dd> /// <para> /// 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 <code>s3:PutLifecycleConfiguration</code> /// permission. /// </para> /// /// <para> /// You can also explicitly deny permissions. An 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: /// </para> /// <ul> <li> /// <para> /// <code>s3:DeleteObject</code> /// </para> /// </li> <li> /// <para> /// <code>s3:DeleteObjectVersion</code> /// </para> /// </li> <li> /// <para> /// <code>s3:PutLifecycleConfiguration</code> /// </para> /// </li> </ul> /// <para> /// For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing /// Access Permissions to Your Amazon S3 Resources</a>. /// </para> /// </dd> </dl> /// <para> /// The following operations are related to <code>PutBucketLifecycleConfiguration</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/lifecycle-configuration-examples.html">Examples /// of Lifecycle Configuration</a> /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html">GetBucketLifecycleConfiguration</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html">DeleteBucketLifecycle</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the PutLifecycleConfiguration service method.</param> /// /// <returns>The response from the PutLifecycleConfiguration service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketLifecycleConfiguration">REST API Reference for PutLifecycleConfiguration Operation</seealso> PutLifecycleConfigurationResponse PutLifecycleConfiguration(PutLifecycleConfigurationRequest request); /// <summary> /// Initiates the asynchronous execution of the PutLifecycleConfiguration operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the PutLifecycleConfiguration operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutLifecycleConfiguration /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketLifecycleConfiguration">REST API Reference for PutLifecycleConfiguration Operation</seealso> IAsyncResult BeginPutLifecycleConfiguration(PutLifecycleConfigurationRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the PutLifecycleConfiguration operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginPutLifecycleConfiguration.</param> /// /// <returns>Returns a PutLifecycleConfigurationResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketLifecycleConfiguration">REST API Reference for PutLifecycleConfiguration Operation</seealso> PutLifecycleConfigurationResponse EndPutLifecycleConfiguration(IAsyncResult asyncResult); #endregion #region PutObject /// <summary> /// Adds an object to a bucket. You must have WRITE permissions on a bucket to add an /// object to it. /// /// <note> /// <para> /// Amazon S3 never adds partial objects; if you receive a success response, Amazon S3 /// added the entire object to the bucket. You cannot use <code>PutObject</code> to only /// update a single piece of metadata for an existing object. You must put the entire /// object with updated metadata if you want to update some values. /// </para> /// </note> /// <para> /// 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. To prevent /// objects from being deleted or overwritten, you can use <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock.html">Amazon /// S3 Object Lock</a>. /// </para> /// /// <para> /// To ensure that data is not corrupted traversing the network, use the <code>Content-MD5</code> /// 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. /// </para> /// <note> <ul> <li> /// <para> /// To successfully complete the <code>PutObject</code> request, you must have the <code>s3:PutObject</code> /// in your IAM permissions. /// </para> /// </li> <li> /// <para> /// To successfully change the objects acl of your <code>PutObject</code> request, you /// must have the <code>s3:PutObjectAcl</code> in your IAM permissions. /// </para> /// </li> <li> /// <para> /// To successfully set the tag-set with your <code>PutObject</code> request, you must /// have the <code>s3:PutObjectTagging</code> in your IAM permissions. /// </para> /// </li> <li> /// <para> /// The <code>Content-MD5</code> 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock-overview.html">Amazon /// S3 Object Lock Overview</a> in the <i>Amazon S3 User Guide</i>. /// </para> /// </li> </ul> </note> /// <para> /// You have four mutually exclusive options to protect data using server-side encryption /// in Amazon S3, depending on how you choose to manage the encryption keys. Specifically, /// the encryption key options are Amazon S3 managed keys (SSE-S3), Amazon Web Services /// KMS keys (SSE-KMS or DSSE-KMS), and customer-provided keys (SSE-C). Amazon S3 encrypts /// data with server-side encryption by using Amazon S3 managed keys (SSE-S3) by default. /// You can optionally tell Amazon S3 to encrypt data at rest by using server-side encryption /// with other key options. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html">Using /// Server-Side Encryption</a>. /// </para> /// /// <para> /// When adding a new object, you can use headers to grant ACL-based 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. By default, all objects are private. Only /// the owner has full access control. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html">Access /// Control List (ACL) Overview</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-using-rest-api.html">Managing /// ACLs Using the REST API</a>. /// </para> /// /// <para> /// 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 <code>bucket-owner-full-control</code> /// 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 <code>400</code> error with the error code <code>AccessControlListNotSupported</code>. /// For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html"> /// Controlling ownership of objects and disabling ACLs</a> in the <i>Amazon S3 User Guide</i>. /// </para> /// <note> /// <para> /// 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. /// </para> /// </note> /// <para> /// 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html">Storage /// Classes</a> in the <i>Amazon S3 User Guide</i>. /// </para> /// /// <para> /// 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/AddingObjectstoVersioningEnabledBuckets.html">Adding /// Objects to Versioning-Enabled Buckets</a>. For information about returning the versioning /// state of a bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html">GetBucketVersioning</a>. /// /// </para> /// /// <para> /// For more information about related Amazon S3 APIs, see the following: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html">CopyObject</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html">DeleteObject</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the PutObject service method.</param> /// /// <returns>The response from the PutObject service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutObject">REST API Reference for PutObject Operation</seealso> PutObjectResponse PutObject(PutObjectRequest request); /// <summary> /// Initiates the asynchronous execution of the PutObject operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the PutObject operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutObject /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutObject">REST API Reference for PutObject Operation</seealso> IAsyncResult BeginPutObject(PutObjectRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the PutObject operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginPutObject.</param> /// /// <returns>Returns a PutObjectResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutObject">REST API Reference for PutObject Operation</seealso> PutObjectResponse EndPutObject(IAsyncResult asyncResult); #endregion #region PutObjectLegalHold /// <summary> /// Applies a legal hold configuration to the specified object. For more information, /// see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Locking /// Objects</a>. /// /// /// <para> /// This action is not supported by Amazon S3 on Outposts. /// </para> /// </summary> /// <param name="request">Container for the necessary parameters to execute the PutObjectLegalHold service method.</param> /// /// <returns>The response from the PutObjectLegalHold service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutObjectLegalHold">REST API Reference for PutObjectLegalHold Operation</seealso> PutObjectLegalHoldResponse PutObjectLegalHold(PutObjectLegalHoldRequest request); /// <summary> /// Initiates the asynchronous execution of the PutObjectLegalHold operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the PutObjectLegalHold operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutObjectLegalHold /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutObjectLegalHold">REST API Reference for PutObjectLegalHold Operation</seealso> IAsyncResult BeginPutObjectLegalHold(PutObjectLegalHoldRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the PutObjectLegalHold operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginPutObjectLegalHold.</param> /// /// <returns>Returns a PutObjectLegalHoldResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutObjectLegalHold">REST API Reference for PutObjectLegalHold Operation</seealso> PutObjectLegalHoldResponse EndPutObjectLegalHold(IAsyncResult asyncResult); #endregion #region PutObjectLockConfiguration /// <summary> /// 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Locking /// Objects</a>. /// /// <note> <ul> <li> /// <para> /// The <code>DefaultRetention</code> settings require both a mode and a period. /// </para> /// </li> <li> /// <para> /// The <code>DefaultRetention</code> period can be either <code>Days</code> or <code>Years</code> /// but you must select one. You cannot specify <code>Days</code> and <code>Years</code> /// at the same time. /// </para> /// </li> <li> /// <para> /// 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. /// </para> /// </li> </ul> </note> /// </summary> /// <param name="request">Container for the necessary parameters to execute the PutObjectLockConfiguration service method.</param> /// /// <returns>The response from the PutObjectLockConfiguration service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutObjectLockConfiguration">REST API Reference for PutObjectLockConfiguration Operation</seealso> PutObjectLockConfigurationResponse PutObjectLockConfiguration(PutObjectLockConfigurationRequest request); /// <summary> /// Initiates the asynchronous execution of the PutObjectLockConfiguration operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the PutObjectLockConfiguration operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutObjectLockConfiguration /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutObjectLockConfiguration">REST API Reference for PutObjectLockConfiguration Operation</seealso> IAsyncResult BeginPutObjectLockConfiguration(PutObjectLockConfigurationRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the PutObjectLockConfiguration operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginPutObjectLockConfiguration.</param> /// /// <returns>Returns a PutObjectLockConfigurationResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutObjectLockConfiguration">REST API Reference for PutObjectLockConfiguration Operation</seealso> PutObjectLockConfigurationResponse EndPutObjectLockConfiguration(IAsyncResult asyncResult); #endregion #region PutObjectRetention /// <summary> /// Places an Object Retention configuration on an object. For more information, see <a /// href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Locking Objects</a>. /// Users or accounts require the <code>s3:PutObjectRetention</code> permission in order /// to place an Object Retention configuration on objects. Bypassing a Governance Retention /// configuration requires the <code>s3:BypassGovernanceRetention</code> permission. /// /// /// <para> /// This action is not supported by Amazon S3 on Outposts. /// </para> /// </summary> /// <param name="request">Container for the necessary parameters to execute the PutObjectRetention service method.</param> /// /// <returns>The response from the PutObjectRetention service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutObjectRetention">REST API Reference for PutObjectRetention Operation</seealso> PutObjectRetentionResponse PutObjectRetention(PutObjectRetentionRequest request); /// <summary> /// Initiates the asynchronous execution of the PutObjectRetention operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the PutObjectRetention operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutObjectRetention /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutObjectRetention">REST API Reference for PutObjectRetention Operation</seealso> IAsyncResult BeginPutObjectRetention(PutObjectRetentionRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the PutObjectRetention operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginPutObjectRetention.</param> /// /// <returns>Returns a PutObjectRetentionResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutObjectRetention">REST API Reference for PutObjectRetention Operation</seealso> PutObjectRetentionResponse EndPutObjectRetention(IAsyncResult asyncResult); #endregion #region PutObjectTagging /// <summary> /// Sets the supplied tag-set to an object that already exists in a bucket. /// /// /// <para> /// 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html">GetObjectTagging</a>. /// </para> /// /// <para> /// For tagging-related restrictions related to characters and encodings, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html">Tag /// Restrictions</a>. Note that Amazon S3 limits the maximum number of tags to 10 tags /// per object. /// </para> /// /// <para> /// To use this operation, you must have permission to perform the <code>s3:PutObjectTagging</code> /// action. By default, the bucket owner has this permission and can grant this permission /// to others. /// </para> /// /// <para> /// To put tags of any other version, use the <code>versionId</code> query parameter. /// You also need permission for the <code>s3:PutObjectVersionTagging</code> action. /// </para> /// /// <para> /// For information about the Amazon S3 object tagging feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html">Object /// Tagging</a>. /// </para> /// /// <para> /// <code>PutObjectTagging</code> has the following special errors: /// </para> /// <ul> <li> <ul> <li> /// <para> /// <i>Code: InvalidTagError </i> /// </para> /// </li> <li> /// <para> /// <i>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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html">Object /// Tagging</a>.</i> /// </para> /// </li> </ul> </li> <li> <ul> <li> /// <para> /// <i>Code: MalformedXMLError </i> /// </para> /// </li> <li> /// <para> /// <i>Cause: The XML provided does not match the schema.</i> /// </para> /// </li> </ul> </li> <li> <ul> <li> /// <para> /// <i>Code: OperationAbortedError </i> /// </para> /// </li> <li> /// <para> /// <i>Cause: A conflicting conditional action is currently in progress against this /// resource. Please try again.</i> /// </para> /// </li> </ul> </li> <li> <ul> <li> /// <para> /// <i>Code: InternalError</i> /// </para> /// </li> <li> /// <para> /// <i>Cause: The service was unable to apply the provided tag to the object.</i> /// </para> /// </li> </ul> </li> </ul> /// <para> /// The following operations are related to <code>PutObjectTagging</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html">GetObjectTagging</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObjectTagging.html">DeleteObjectTagging</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the PutObjectTagging service method.</param> /// /// <returns>The response from the PutObjectTagging service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutObjectTagging">REST API Reference for PutObjectTagging Operation</seealso> PutObjectTaggingResponse PutObjectTagging(PutObjectTaggingRequest request); /// <summary> /// Initiates the asynchronous execution of the PutObjectTagging operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the PutObjectTagging operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutObjectTagging /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutObjectTagging">REST API Reference for PutObjectTagging Operation</seealso> IAsyncResult BeginPutObjectTagging(PutObjectTaggingRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the PutObjectTagging operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginPutObjectTagging.</param> /// /// <returns>Returns a PutObjectTaggingResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutObjectTagging">REST API Reference for PutObjectTagging Operation</seealso> PutObjectTaggingResponse EndPutObjectTagging(IAsyncResult asyncResult); #endregion #region PutPublicAccessBlock /// <summary> /// Creates or modifies the <code>PublicAccessBlock</code> configuration for an Amazon /// S3 bucket. To use this operation, you must have the <code>s3:PutBucketPublicAccessBlock</code> /// permission. For more information about Amazon S3 permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying /// Permissions in a Policy</a>. /// /// <important> /// <para> /// When Amazon S3 evaluates the <code>PublicAccessBlock</code> configuration for a bucket /// or an object, it checks the <code>PublicAccessBlock</code> configuration for both /// the bucket (or the bucket that contains the object) and the bucket owner's account. /// If the <code>PublicAccessBlock</code> configurations are different between the bucket /// and the account, Amazon S3 uses the most restrictive combination of the bucket-level /// and account-level settings. /// </para> /// </important> /// <para> /// For more information about when Amazon S3 considers a bucket or an object public, /// see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status">The /// Meaning of "Public"</a>. /// </para> /// /// <para> /// The following operations are related to <code>PutPublicAccessBlock</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html">GetPublicAccessBlock</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeletePublicAccessBlock.html">DeletePublicAccessBlock</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketPolicyStatus.html">GetBucketPolicyStatus</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html">Using /// Amazon S3 Block Public Access</a> /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the PutPublicAccessBlock service method.</param> /// /// <returns>The response from the PutPublicAccessBlock service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutPublicAccessBlock">REST API Reference for PutPublicAccessBlock Operation</seealso> PutPublicAccessBlockResponse PutPublicAccessBlock(PutPublicAccessBlockRequest request); /// <summary> /// Initiates the asynchronous execution of the PutPublicAccessBlock operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the PutPublicAccessBlock operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutPublicAccessBlock /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutPublicAccessBlock">REST API Reference for PutPublicAccessBlock Operation</seealso> IAsyncResult BeginPutPublicAccessBlock(PutPublicAccessBlockRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the PutPublicAccessBlock operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginPutPublicAccessBlock.</param> /// /// <returns>Returns a PutPublicAccessBlockResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutPublicAccessBlock">REST API Reference for PutPublicAccessBlock Operation</seealso> PutPublicAccessBlockResponse EndPutPublicAccessBlock(IAsyncResult asyncResult); #endregion #region RestoreObject /// <summary> /// Restores an archived copy of an object back into Amazon S3 /// /// /// <para> /// This action is not supported by Amazon S3 on Outposts. /// </para> /// /// <para> /// This action performs the following types of requests: /// </para> /// <ul> <li> /// <para> /// <code>select</code> - Perform a select query on an archived object /// </para> /// </li> <li> /// <para> /// <code>restore an archive</code> - Restore an archived object /// </para> /// </li> </ul> /// <para> /// For more information about the <code>S3</code> structure in the request body, see /// the following: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html">PutObject</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html">Managing /// Access with ACLs</a> in the <i>Amazon S3 User Guide</i> /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html">Protecting /// Data Using Server-Side Encryption</a> in the <i>Amazon S3 User Guide</i> /// </para> /// </li> </ul> /// <para> /// Define the SQL expression for the <code>SELECT</code> type of restoration for your /// query in the request body's <code>SelectParameters</code> structure. You can use expressions /// like the following examples. /// </para> /// <ul> <li> /// <para> /// The following expression returns all records from the specified object. /// </para> /// /// <para> /// <code>SELECT * FROM Object</code> /// </para> /// </li> <li> /// <para> /// Assuming that you are not using any headers for data stored in the object, you can /// specify columns with positional headers. /// </para> /// /// <para> /// <code>SELECT s._1, s._2 FROM Object s WHERE s._3 > 100</code> /// </para> /// </li> <li> /// <para> /// If you have headers and you set the <code>fileHeaderInfo</code> in the <code>CSV</code> /// structure in the request body to <code>USE</code>, you can specify headers in the /// query. (If you set the <code>fileHeaderInfo</code> field to <code>IGNORE</code>, the /// first row is skipped for the query.) You cannot mix ordinal positions with header /// column names. /// </para> /// /// <para> /// <code>SELECT s.Id, s.FirstName, s.SSN FROM S3Object s</code> /// </para> /// </li> </ul> /// <para> /// When making a select request, you can also do the following: /// </para> /// <ul> <li> /// <para> /// To expedite your queries, specify the <code>Expedited</code> tier. For more information /// about tiers, see "Restoring Archives," later in this topic. /// </para> /// </li> <li> /// <para> /// 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. /// </para> /// </li> </ul> /// <para> /// The following are additional important facts about the select feature: /// </para> /// <ul> <li> /// <para> /// The output results are new Amazon S3 objects. Unlike archive retrievals, they are /// stored until explicitly deleted-manually or through a lifecycle configuration. /// </para> /// </li> <li> /// <para> /// You can issue more than one select request on the same Amazon S3 object. Amazon S3 /// doesn't duplicate requests, so avoid issuing duplicate requests. /// </para> /// </li> <li> /// <para> /// Amazon S3 accepts a select request even if the object has already been restored. /// A select request doesn’t return error response <code>409</code>. /// </para> /// </li> </ul> <dl> <dt>Permissions</dt> <dd> /// <para> /// To use this operation, you must have permissions to perform the <code>s3:RestoreObject</code> /// action. The bucket owner has this permission by default and can grant this permission /// to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions /// Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing /// Access Permissions to Your Amazon S3 Resources</a> in the <i>Amazon S3 User Guide</i>. /// </para> /// </dd> <dt>Restoring objects</dt> <dd> /// <para> /// Objects that you archive to the S3 Glacier Flexible Retrieval Flexible Retrieval 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 the S3 Glacier /// Flexible Retrieval Flexible Retrieval 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. If you want a permanent copy of the object, create a copy /// of it in the Amazon S3 Standard storage class in your S3 bucket. To access an archived /// object, you must restore the object for the duration (number of days) that you specify. /// For objects in the Archive Access or Deep Archive Access tiers of S3 Intelligent-Tiering, /// you must first initiate a restore request, and then wait until the object is moved /// into the Frequent Access tier. /// </para> /// /// <para> /// 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. /// </para> /// /// <para> /// When restoring an archived object, you can specify one of the following data access /// tier options in the <code>Tier</code> element of the request body: /// </para> /// <ul> <li> /// <para> /// <code>Expedited</code> - Expedited retrievals allow you to quickly access your data /// stored in the S3 Glacier Flexible Retrieval Flexible Retrieval storage class or S3 /// Intelligent-Tiering Archive tier when occasional urgent requests for restoring 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. /// </para> /// </li> <li> /// <para> /// <code>Standard</code> - 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 Flexible Retrieval Flexible Retrieval 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. /// </para> /// </li> <li> /// <para> /// <code>Bulk</code> - Bulk retrievals free for objects stored in the S3 Glacier Flexible /// Retrieval and S3 Intelligent-Tiering storage classes, enabling you to retrieve large /// amounts, even petabytes, of data at no cost. Bulk retrievals typically finish within /// 5–12 hours for objects stored in the S3 Glacier Flexible Retrieval Flexible Retrieval /// storage class or S3 Intelligent-Tiering Archive tier. Bulk retrievals are also the /// lowest-cost retrieval option when restoring objects from S3 Glacier Deep Archive. /// They typically finish within 48 hours for objects stored in the S3 Glacier Deep Archive /// storage class or S3 Intelligent-Tiering Deep Archive tier. /// </para> /// </li> </ul> /// <para> /// For more information about archive retrieval options and provisioned capacity for /// <code>Expedited</code> data access, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html">Restoring /// Archived Objects</a> in the <i>Amazon S3 User Guide</i>. /// </para> /// /// <para> /// 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html#restoring-objects-upgrade-tier.title.html"> /// Upgrading the speed of an in-progress restore</a> in the <i>Amazon S3 User Guide</i>. /// /// </para> /// /// <para> /// To get the status of object restoration, you can send a <code>HEAD</code> request. /// Operations return the <code>x-amz-restore</code> 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 /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html">Configuring /// Amazon S3 Event Notifications</a> in the <i>Amazon S3 User Guide</i>. /// </para> /// /// <para> /// 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. /// </para> /// /// <para> /// 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html">PutBucketLifecycleConfiguration</a> /// and <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html">Object /// Lifecycle Management</a> in <i>Amazon S3 User Guide</i>. /// </para> /// </dd> <dt>Responses</dt> <dd> /// <para> /// A successful action returns either the <code>200 OK</code> or <code>202 Accepted</code> /// status code. /// </para> /// <ul> <li> /// <para> /// If the object is not previously restored, then Amazon S3 returns <code>202 Accepted</code> /// in the response. /// </para> /// </li> <li> /// <para> /// If the object is previously restored, Amazon S3 returns <code>200 OK</code> in the /// response. /// </para> /// </li> </ul> <ul> <li> /// <para> /// Special errors: /// </para> /// <ul> <li> /// <para> /// <i>Code: RestoreAlreadyInProgress</i> /// </para> /// </li> <li> /// <para> /// <i>Cause: Object restore is already in progress. (This error does not apply to SELECT /// type requests.)</i> /// </para> /// </li> <li> /// <para> /// <i>HTTP Status Code: 409 Conflict</i> /// </para> /// </li> <li> /// <para> /// <i>SOAP Fault Code Prefix: Client</i> /// </para> /// </li> </ul> </li> <li> <ul> <li> /// <para> /// <i>Code: GlacierExpeditedRetrievalNotAvailable</i> /// </para> /// </li> <li> /// <para> /// <i>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.)</i> /// </para> /// </li> <li> /// <para> /// <i>HTTP Status Code: 503</i> /// </para> /// </li> <li> /// <para> /// <i>SOAP Fault Code Prefix: N/A</i> /// </para> /// </li> </ul> </li> </ul> </dd> </dl> /// <para> /// The following operations are related to <code>RestoreObject</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html">PutBucketLifecycleConfiguration</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketNotificationConfiguration.html">GetBucketNotificationConfiguration</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="bucketName">The bucket name containing the object to restore. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>. When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</param> /// <param name="key">Object key for which the action was initiated.</param> /// /// <returns>The response from the RestoreObject service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/RestoreObject">REST API Reference for RestoreObject Operation</seealso> RestoreObjectResponse RestoreObject(string bucketName, string key); /// <summary> /// Restores an archived copy of an object back into Amazon S3 /// /// /// <para> /// This action is not supported by Amazon S3 on Outposts. /// </para> /// /// <para> /// This action performs the following types of requests: /// </para> /// <ul> <li> /// <para> /// <code>select</code> - Perform a select query on an archived object /// </para> /// </li> <li> /// <para> /// <code>restore an archive</code> - Restore an archived object /// </para> /// </li> </ul> /// <para> /// For more information about the <code>S3</code> structure in the request body, see /// the following: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html">PutObject</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html">Managing /// Access with ACLs</a> in the <i>Amazon S3 User Guide</i> /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html">Protecting /// Data Using Server-Side Encryption</a> in the <i>Amazon S3 User Guide</i> /// </para> /// </li> </ul> /// <para> /// Define the SQL expression for the <code>SELECT</code> type of restoration for your /// query in the request body's <code>SelectParameters</code> structure. You can use expressions /// like the following examples. /// </para> /// <ul> <li> /// <para> /// The following expression returns all records from the specified object. /// </para> /// /// <para> /// <code>SELECT * FROM Object</code> /// </para> /// </li> <li> /// <para> /// Assuming that you are not using any headers for data stored in the object, you can /// specify columns with positional headers. /// </para> /// /// <para> /// <code>SELECT s._1, s._2 FROM Object s WHERE s._3 > 100</code> /// </para> /// </li> <li> /// <para> /// If you have headers and you set the <code>fileHeaderInfo</code> in the <code>CSV</code> /// structure in the request body to <code>USE</code>, you can specify headers in the /// query. (If you set the <code>fileHeaderInfo</code> field to <code>IGNORE</code>, the /// first row is skipped for the query.) You cannot mix ordinal positions with header /// column names. /// </para> /// /// <para> /// <code>SELECT s.Id, s.FirstName, s.SSN FROM S3Object s</code> /// </para> /// </li> </ul> /// <para> /// When making a select request, you can also do the following: /// </para> /// <ul> <li> /// <para> /// To expedite your queries, specify the <code>Expedited</code> tier. For more information /// about tiers, see "Restoring Archives," later in this topic. /// </para> /// </li> <li> /// <para> /// 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. /// </para> /// </li> </ul> /// <para> /// The following are additional important facts about the select feature: /// </para> /// <ul> <li> /// <para> /// The output results are new Amazon S3 objects. Unlike archive retrievals, they are /// stored until explicitly deleted-manually or through a lifecycle configuration. /// </para> /// </li> <li> /// <para> /// You can issue more than one select request on the same Amazon S3 object. Amazon S3 /// doesn't duplicate requests, so avoid issuing duplicate requests. /// </para> /// </li> <li> /// <para> /// Amazon S3 accepts a select request even if the object has already been restored. /// A select request doesn’t return error response <code>409</code>. /// </para> /// </li> </ul> <dl> <dt>Permissions</dt> <dd> /// <para> /// To use this operation, you must have permissions to perform the <code>s3:RestoreObject</code> /// action. The bucket owner has this permission by default and can grant this permission /// to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions /// Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing /// Access Permissions to Your Amazon S3 Resources</a> in the <i>Amazon S3 User Guide</i>. /// </para> /// </dd> <dt>Restoring objects</dt> <dd> /// <para> /// Objects that you archive to the S3 Glacier Flexible Retrieval Flexible Retrieval 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 the S3 Glacier /// Flexible Retrieval Flexible Retrieval 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. If you want a permanent copy of the object, create a copy /// of it in the Amazon S3 Standard storage class in your S3 bucket. To access an archived /// object, you must restore the object for the duration (number of days) that you specify. /// For objects in the Archive Access or Deep Archive Access tiers of S3 Intelligent-Tiering, /// you must first initiate a restore request, and then wait until the object is moved /// into the Frequent Access tier. /// </para> /// /// <para> /// 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. /// </para> /// /// <para> /// When restoring an archived object, you can specify one of the following data access /// tier options in the <code>Tier</code> element of the request body: /// </para> /// <ul> <li> /// <para> /// <code>Expedited</code> - Expedited retrievals allow you to quickly access your data /// stored in the S3 Glacier Flexible Retrieval Flexible Retrieval storage class or S3 /// Intelligent-Tiering Archive tier when occasional urgent requests for restoring 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. /// </para> /// </li> <li> /// <para> /// <code>Standard</code> - 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 Flexible Retrieval Flexible Retrieval 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. /// </para> /// </li> <li> /// <para> /// <code>Bulk</code> - Bulk retrievals free for objects stored in the S3 Glacier Flexible /// Retrieval and S3 Intelligent-Tiering storage classes, enabling you to retrieve large /// amounts, even petabytes, of data at no cost. Bulk retrievals typically finish within /// 5–12 hours for objects stored in the S3 Glacier Flexible Retrieval Flexible Retrieval /// storage class or S3 Intelligent-Tiering Archive tier. Bulk retrievals are also the /// lowest-cost retrieval option when restoring objects from S3 Glacier Deep Archive. /// They typically finish within 48 hours for objects stored in the S3 Glacier Deep Archive /// storage class or S3 Intelligent-Tiering Deep Archive tier. /// </para> /// </li> </ul> /// <para> /// For more information about archive retrieval options and provisioned capacity for /// <code>Expedited</code> data access, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html">Restoring /// Archived Objects</a> in the <i>Amazon S3 User Guide</i>. /// </para> /// /// <para> /// 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html#restoring-objects-upgrade-tier.title.html"> /// Upgrading the speed of an in-progress restore</a> in the <i>Amazon S3 User Guide</i>. /// /// </para> /// /// <para> /// To get the status of object restoration, you can send a <code>HEAD</code> request. /// Operations return the <code>x-amz-restore</code> 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 /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html">Configuring /// Amazon S3 Event Notifications</a> in the <i>Amazon S3 User Guide</i>. /// </para> /// /// <para> /// 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. /// </para> /// /// <para> /// 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html">PutBucketLifecycleConfiguration</a> /// and <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html">Object /// Lifecycle Management</a> in <i>Amazon S3 User Guide</i>. /// </para> /// </dd> <dt>Responses</dt> <dd> /// <para> /// A successful action returns either the <code>200 OK</code> or <code>202 Accepted</code> /// status code. /// </para> /// <ul> <li> /// <para> /// If the object is not previously restored, then Amazon S3 returns <code>202 Accepted</code> /// in the response. /// </para> /// </li> <li> /// <para> /// If the object is previously restored, Amazon S3 returns <code>200 OK</code> in the /// response. /// </para> /// </li> </ul> <ul> <li> /// <para> /// Special errors: /// </para> /// <ul> <li> /// <para> /// <i>Code: RestoreAlreadyInProgress</i> /// </para> /// </li> <li> /// <para> /// <i>Cause: Object restore is already in progress. (This error does not apply to SELECT /// type requests.)</i> /// </para> /// </li> <li> /// <para> /// <i>HTTP Status Code: 409 Conflict</i> /// </para> /// </li> <li> /// <para> /// <i>SOAP Fault Code Prefix: Client</i> /// </para> /// </li> </ul> </li> <li> <ul> <li> /// <para> /// <i>Code: GlacierExpeditedRetrievalNotAvailable</i> /// </para> /// </li> <li> /// <para> /// <i>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.)</i> /// </para> /// </li> <li> /// <para> /// <i>HTTP Status Code: 503</i> /// </para> /// </li> <li> /// <para> /// <i>SOAP Fault Code Prefix: N/A</i> /// </para> /// </li> </ul> </li> </ul> </dd> </dl> /// <para> /// The following operations are related to <code>RestoreObject</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html">PutBucketLifecycleConfiguration</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketNotificationConfiguration.html">GetBucketNotificationConfiguration</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="bucketName">The bucket name containing the object to restore. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>. When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</param> /// <param name="key">Object key for which the action was initiated.</param> /// <param name="days">A property of RestoreObjectRequest used to execute the RestoreObject service method.</param> /// /// <returns>The response from the RestoreObject service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/RestoreObject">REST API Reference for RestoreObject Operation</seealso> RestoreObjectResponse RestoreObject(string bucketName, string key, int days); /// <summary> /// Restores an archived copy of an object back into Amazon S3 /// /// /// <para> /// This action is not supported by Amazon S3 on Outposts. /// </para> /// /// <para> /// This action performs the following types of requests: /// </para> /// <ul> <li> /// <para> /// <code>select</code> - Perform a select query on an archived object /// </para> /// </li> <li> /// <para> /// <code>restore an archive</code> - Restore an archived object /// </para> /// </li> </ul> /// <para> /// For more information about the <code>S3</code> structure in the request body, see /// the following: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html">PutObject</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html">Managing /// Access with ACLs</a> in the <i>Amazon S3 User Guide</i> /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html">Protecting /// Data Using Server-Side Encryption</a> in the <i>Amazon S3 User Guide</i> /// </para> /// </li> </ul> /// <para> /// Define the SQL expression for the <code>SELECT</code> type of restoration for your /// query in the request body's <code>SelectParameters</code> structure. You can use expressions /// like the following examples. /// </para> /// <ul> <li> /// <para> /// The following expression returns all records from the specified object. /// </para> /// /// <para> /// <code>SELECT * FROM Object</code> /// </para> /// </li> <li> /// <para> /// Assuming that you are not using any headers for data stored in the object, you can /// specify columns with positional headers. /// </para> /// /// <para> /// <code>SELECT s._1, s._2 FROM Object s WHERE s._3 > 100</code> /// </para> /// </li> <li> /// <para> /// If you have headers and you set the <code>fileHeaderInfo</code> in the <code>CSV</code> /// structure in the request body to <code>USE</code>, you can specify headers in the /// query. (If you set the <code>fileHeaderInfo</code> field to <code>IGNORE</code>, the /// first row is skipped for the query.) You cannot mix ordinal positions with header /// column names. /// </para> /// /// <para> /// <code>SELECT s.Id, s.FirstName, s.SSN FROM S3Object s</code> /// </para> /// </li> </ul> /// <para> /// When making a select request, you can also do the following: /// </para> /// <ul> <li> /// <para> /// To expedite your queries, specify the <code>Expedited</code> tier. For more information /// about tiers, see "Restoring Archives," later in this topic. /// </para> /// </li> <li> /// <para> /// 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. /// </para> /// </li> </ul> /// <para> /// The following are additional important facts about the select feature: /// </para> /// <ul> <li> /// <para> /// The output results are new Amazon S3 objects. Unlike archive retrievals, they are /// stored until explicitly deleted-manually or through a lifecycle configuration. /// </para> /// </li> <li> /// <para> /// You can issue more than one select request on the same Amazon S3 object. Amazon S3 /// doesn't duplicate requests, so avoid issuing duplicate requests. /// </para> /// </li> <li> /// <para> /// Amazon S3 accepts a select request even if the object has already been restored. /// A select request doesn’t return error response <code>409</code>. /// </para> /// </li> </ul> <dl> <dt>Permissions</dt> <dd> /// <para> /// To use this operation, you must have permissions to perform the <code>s3:RestoreObject</code> /// action. The bucket owner has this permission by default and can grant this permission /// to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions /// Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing /// Access Permissions to Your Amazon S3 Resources</a> in the <i>Amazon S3 User Guide</i>. /// </para> /// </dd> <dt>Restoring objects</dt> <dd> /// <para> /// Objects that you archive to the S3 Glacier Flexible Retrieval Flexible Retrieval 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 the S3 Glacier /// Flexible Retrieval Flexible Retrieval 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. If you want a permanent copy of the object, create a copy /// of it in the Amazon S3 Standard storage class in your S3 bucket. To access an archived /// object, you must restore the object for the duration (number of days) that you specify. /// For objects in the Archive Access or Deep Archive Access tiers of S3 Intelligent-Tiering, /// you must first initiate a restore request, and then wait until the object is moved /// into the Frequent Access tier. /// </para> /// /// <para> /// 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. /// </para> /// /// <para> /// When restoring an archived object, you can specify one of the following data access /// tier options in the <code>Tier</code> element of the request body: /// </para> /// <ul> <li> /// <para> /// <code>Expedited</code> - Expedited retrievals allow you to quickly access your data /// stored in the S3 Glacier Flexible Retrieval Flexible Retrieval storage class or S3 /// Intelligent-Tiering Archive tier when occasional urgent requests for restoring 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. /// </para> /// </li> <li> /// <para> /// <code>Standard</code> - 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 Flexible Retrieval Flexible Retrieval 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. /// </para> /// </li> <li> /// <para> /// <code>Bulk</code> - Bulk retrievals free for objects stored in the S3 Glacier Flexible /// Retrieval and S3 Intelligent-Tiering storage classes, enabling you to retrieve large /// amounts, even petabytes, of data at no cost. Bulk retrievals typically finish within /// 5–12 hours for objects stored in the S3 Glacier Flexible Retrieval Flexible Retrieval /// storage class or S3 Intelligent-Tiering Archive tier. Bulk retrievals are also the /// lowest-cost retrieval option when restoring objects from S3 Glacier Deep Archive. /// They typically finish within 48 hours for objects stored in the S3 Glacier Deep Archive /// storage class or S3 Intelligent-Tiering Deep Archive tier. /// </para> /// </li> </ul> /// <para> /// For more information about archive retrieval options and provisioned capacity for /// <code>Expedited</code> data access, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html">Restoring /// Archived Objects</a> in the <i>Amazon S3 User Guide</i>. /// </para> /// /// <para> /// 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html#restoring-objects-upgrade-tier.title.html"> /// Upgrading the speed of an in-progress restore</a> in the <i>Amazon S3 User Guide</i>. /// /// </para> /// /// <para> /// To get the status of object restoration, you can send a <code>HEAD</code> request. /// Operations return the <code>x-amz-restore</code> 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 /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html">Configuring /// Amazon S3 Event Notifications</a> in the <i>Amazon S3 User Guide</i>. /// </para> /// /// <para> /// 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. /// </para> /// /// <para> /// 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html">PutBucketLifecycleConfiguration</a> /// and <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html">Object /// Lifecycle Management</a> in <i>Amazon S3 User Guide</i>. /// </para> /// </dd> <dt>Responses</dt> <dd> /// <para> /// A successful action returns either the <code>200 OK</code> or <code>202 Accepted</code> /// status code. /// </para> /// <ul> <li> /// <para> /// If the object is not previously restored, then Amazon S3 returns <code>202 Accepted</code> /// in the response. /// </para> /// </li> <li> /// <para> /// If the object is previously restored, Amazon S3 returns <code>200 OK</code> in the /// response. /// </para> /// </li> </ul> <ul> <li> /// <para> /// Special errors: /// </para> /// <ul> <li> /// <para> /// <i>Code: RestoreAlreadyInProgress</i> /// </para> /// </li> <li> /// <para> /// <i>Cause: Object restore is already in progress. (This error does not apply to SELECT /// type requests.)</i> /// </para> /// </li> <li> /// <para> /// <i>HTTP Status Code: 409 Conflict</i> /// </para> /// </li> <li> /// <para> /// <i>SOAP Fault Code Prefix: Client</i> /// </para> /// </li> </ul> </li> <li> <ul> <li> /// <para> /// <i>Code: GlacierExpeditedRetrievalNotAvailable</i> /// </para> /// </li> <li> /// <para> /// <i>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.)</i> /// </para> /// </li> <li> /// <para> /// <i>HTTP Status Code: 503</i> /// </para> /// </li> <li> /// <para> /// <i>SOAP Fault Code Prefix: N/A</i> /// </para> /// </li> </ul> </li> </ul> </dd> </dl> /// <para> /// The following operations are related to <code>RestoreObject</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html">PutBucketLifecycleConfiguration</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketNotificationConfiguration.html">GetBucketNotificationConfiguration</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="bucketName">The bucket name containing the object to restore. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>. When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</param> /// <param name="key">Object key for which the action was initiated.</param> /// <param name="versionId">VersionId used to reference a specific version of the object.</param> /// /// <returns>The response from the RestoreObject service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/RestoreObject">REST API Reference for RestoreObject Operation</seealso> RestoreObjectResponse RestoreObject(string bucketName, string key, string versionId); /// <summary> /// Restores an archived copy of an object back into Amazon S3 /// /// /// <para> /// This action is not supported by Amazon S3 on Outposts. /// </para> /// /// <para> /// This action performs the following types of requests: /// </para> /// <ul> <li> /// <para> /// <code>select</code> - Perform a select query on an archived object /// </para> /// </li> <li> /// <para> /// <code>restore an archive</code> - Restore an archived object /// </para> /// </li> </ul> /// <para> /// For more information about the <code>S3</code> structure in the request body, see /// the following: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html">PutObject</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html">Managing /// Access with ACLs</a> in the <i>Amazon S3 User Guide</i> /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html">Protecting /// Data Using Server-Side Encryption</a> in the <i>Amazon S3 User Guide</i> /// </para> /// </li> </ul> /// <para> /// Define the SQL expression for the <code>SELECT</code> type of restoration for your /// query in the request body's <code>SelectParameters</code> structure. You can use expressions /// like the following examples. /// </para> /// <ul> <li> /// <para> /// The following expression returns all records from the specified object. /// </para> /// /// <para> /// <code>SELECT * FROM Object</code> /// </para> /// </li> <li> /// <para> /// Assuming that you are not using any headers for data stored in the object, you can /// specify columns with positional headers. /// </para> /// /// <para> /// <code>SELECT s._1, s._2 FROM Object s WHERE s._3 > 100</code> /// </para> /// </li> <li> /// <para> /// If you have headers and you set the <code>fileHeaderInfo</code> in the <code>CSV</code> /// structure in the request body to <code>USE</code>, you can specify headers in the /// query. (If you set the <code>fileHeaderInfo</code> field to <code>IGNORE</code>, the /// first row is skipped for the query.) You cannot mix ordinal positions with header /// column names. /// </para> /// /// <para> /// <code>SELECT s.Id, s.FirstName, s.SSN FROM S3Object s</code> /// </para> /// </li> </ul> /// <para> /// When making a select request, you can also do the following: /// </para> /// <ul> <li> /// <para> /// To expedite your queries, specify the <code>Expedited</code> tier. For more information /// about tiers, see "Restoring Archives," later in this topic. /// </para> /// </li> <li> /// <para> /// 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. /// </para> /// </li> </ul> /// <para> /// The following are additional important facts about the select feature: /// </para> /// <ul> <li> /// <para> /// The output results are new Amazon S3 objects. Unlike archive retrievals, they are /// stored until explicitly deleted-manually or through a lifecycle configuration. /// </para> /// </li> <li> /// <para> /// You can issue more than one select request on the same Amazon S3 object. Amazon S3 /// doesn't duplicate requests, so avoid issuing duplicate requests. /// </para> /// </li> <li> /// <para> /// Amazon S3 accepts a select request even if the object has already been restored. /// A select request doesn’t return error response <code>409</code>. /// </para> /// </li> </ul> <dl> <dt>Permissions</dt> <dd> /// <para> /// To use this operation, you must have permissions to perform the <code>s3:RestoreObject</code> /// action. The bucket owner has this permission by default and can grant this permission /// to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions /// Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing /// Access Permissions to Your Amazon S3 Resources</a> in the <i>Amazon S3 User Guide</i>. /// </para> /// </dd> <dt>Restoring objects</dt> <dd> /// <para> /// Objects that you archive to the S3 Glacier Flexible Retrieval Flexible Retrieval 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 the S3 Glacier /// Flexible Retrieval Flexible Retrieval 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. If you want a permanent copy of the object, create a copy /// of it in the Amazon S3 Standard storage class in your S3 bucket. To access an archived /// object, you must restore the object for the duration (number of days) that you specify. /// For objects in the Archive Access or Deep Archive Access tiers of S3 Intelligent-Tiering, /// you must first initiate a restore request, and then wait until the object is moved /// into the Frequent Access tier. /// </para> /// /// <para> /// 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. /// </para> /// /// <para> /// When restoring an archived object, you can specify one of the following data access /// tier options in the <code>Tier</code> element of the request body: /// </para> /// <ul> <li> /// <para> /// <code>Expedited</code> - Expedited retrievals allow you to quickly access your data /// stored in the S3 Glacier Flexible Retrieval Flexible Retrieval storage class or S3 /// Intelligent-Tiering Archive tier when occasional urgent requests for restoring 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. /// </para> /// </li> <li> /// <para> /// <code>Standard</code> - 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 Flexible Retrieval Flexible Retrieval 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. /// </para> /// </li> <li> /// <para> /// <code>Bulk</code> - Bulk retrievals free for objects stored in the S3 Glacier Flexible /// Retrieval and S3 Intelligent-Tiering storage classes, enabling you to retrieve large /// amounts, even petabytes, of data at no cost. Bulk retrievals typically finish within /// 5–12 hours for objects stored in the S3 Glacier Flexible Retrieval Flexible Retrieval /// storage class or S3 Intelligent-Tiering Archive tier. Bulk retrievals are also the /// lowest-cost retrieval option when restoring objects from S3 Glacier Deep Archive. /// They typically finish within 48 hours for objects stored in the S3 Glacier Deep Archive /// storage class or S3 Intelligent-Tiering Deep Archive tier. /// </para> /// </li> </ul> /// <para> /// For more information about archive retrieval options and provisioned capacity for /// <code>Expedited</code> data access, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html">Restoring /// Archived Objects</a> in the <i>Amazon S3 User Guide</i>. /// </para> /// /// <para> /// 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html#restoring-objects-upgrade-tier.title.html"> /// Upgrading the speed of an in-progress restore</a> in the <i>Amazon S3 User Guide</i>. /// /// </para> /// /// <para> /// To get the status of object restoration, you can send a <code>HEAD</code> request. /// Operations return the <code>x-amz-restore</code> 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 /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html">Configuring /// Amazon S3 Event Notifications</a> in the <i>Amazon S3 User Guide</i>. /// </para> /// /// <para> /// 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. /// </para> /// /// <para> /// 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html">PutBucketLifecycleConfiguration</a> /// and <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html">Object /// Lifecycle Management</a> in <i>Amazon S3 User Guide</i>. /// </para> /// </dd> <dt>Responses</dt> <dd> /// <para> /// A successful action returns either the <code>200 OK</code> or <code>202 Accepted</code> /// status code. /// </para> /// <ul> <li> /// <para> /// If the object is not previously restored, then Amazon S3 returns <code>202 Accepted</code> /// in the response. /// </para> /// </li> <li> /// <para> /// If the object is previously restored, Amazon S3 returns <code>200 OK</code> in the /// response. /// </para> /// </li> </ul> <ul> <li> /// <para> /// Special errors: /// </para> /// <ul> <li> /// <para> /// <i>Code: RestoreAlreadyInProgress</i> /// </para> /// </li> <li> /// <para> /// <i>Cause: Object restore is already in progress. (This error does not apply to SELECT /// type requests.)</i> /// </para> /// </li> <li> /// <para> /// <i>HTTP Status Code: 409 Conflict</i> /// </para> /// </li> <li> /// <para> /// <i>SOAP Fault Code Prefix: Client</i> /// </para> /// </li> </ul> </li> <li> <ul> <li> /// <para> /// <i>Code: GlacierExpeditedRetrievalNotAvailable</i> /// </para> /// </li> <li> /// <para> /// <i>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.)</i> /// </para> /// </li> <li> /// <para> /// <i>HTTP Status Code: 503</i> /// </para> /// </li> <li> /// <para> /// <i>SOAP Fault Code Prefix: N/A</i> /// </para> /// </li> </ul> </li> </ul> </dd> </dl> /// <para> /// The following operations are related to <code>RestoreObject</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html">PutBucketLifecycleConfiguration</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketNotificationConfiguration.html">GetBucketNotificationConfiguration</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="bucketName">The bucket name containing the object to restore. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>. When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</param> /// <param name="key">Object key for which the action was initiated.</param> /// <param name="versionId">VersionId used to reference a specific version of the object.</param> /// <param name="days">A property of RestoreObjectRequest used to execute the RestoreObject service method.</param> /// /// <returns>The response from the RestoreObject service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/RestoreObject">REST API Reference for RestoreObject Operation</seealso> RestoreObjectResponse RestoreObject(string bucketName, string key, string versionId, int days); /// <summary> /// Restores an archived copy of an object back into Amazon S3 /// /// /// <para> /// This action is not supported by Amazon S3 on Outposts. /// </para> /// /// <para> /// This action performs the following types of requests: /// </para> /// <ul> <li> /// <para> /// <code>select</code> - Perform a select query on an archived object /// </para> /// </li> <li> /// <para> /// <code>restore an archive</code> - Restore an archived object /// </para> /// </li> </ul> /// <para> /// For more information about the <code>S3</code> structure in the request body, see /// the following: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html">PutObject</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html">Managing /// Access with ACLs</a> in the <i>Amazon S3 User Guide</i> /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html">Protecting /// Data Using Server-Side Encryption</a> in the <i>Amazon S3 User Guide</i> /// </para> /// </li> </ul> /// <para> /// Define the SQL expression for the <code>SELECT</code> type of restoration for your /// query in the request body's <code>SelectParameters</code> structure. You can use expressions /// like the following examples. /// </para> /// <ul> <li> /// <para> /// The following expression returns all records from the specified object. /// </para> /// /// <para> /// <code>SELECT * FROM Object</code> /// </para> /// </li> <li> /// <para> /// Assuming that you are not using any headers for data stored in the object, you can /// specify columns with positional headers. /// </para> /// /// <para> /// <code>SELECT s._1, s._2 FROM Object s WHERE s._3 > 100</code> /// </para> /// </li> <li> /// <para> /// If you have headers and you set the <code>fileHeaderInfo</code> in the <code>CSV</code> /// structure in the request body to <code>USE</code>, you can specify headers in the /// query. (If you set the <code>fileHeaderInfo</code> field to <code>IGNORE</code>, the /// first row is skipped for the query.) You cannot mix ordinal positions with header /// column names. /// </para> /// /// <para> /// <code>SELECT s.Id, s.FirstName, s.SSN FROM S3Object s</code> /// </para> /// </li> </ul> /// <para> /// When making a select request, you can also do the following: /// </para> /// <ul> <li> /// <para> /// To expedite your queries, specify the <code>Expedited</code> tier. For more information /// about tiers, see "Restoring Archives," later in this topic. /// </para> /// </li> <li> /// <para> /// 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. /// </para> /// </li> </ul> /// <para> /// The following are additional important facts about the select feature: /// </para> /// <ul> <li> /// <para> /// The output results are new Amazon S3 objects. Unlike archive retrievals, they are /// stored until explicitly deleted-manually or through a lifecycle configuration. /// </para> /// </li> <li> /// <para> /// You can issue more than one select request on the same Amazon S3 object. Amazon S3 /// doesn't duplicate requests, so avoid issuing duplicate requests. /// </para> /// </li> <li> /// <para> /// Amazon S3 accepts a select request even if the object has already been restored. /// A select request doesn’t return error response <code>409</code>. /// </para> /// </li> </ul> <dl> <dt>Permissions</dt> <dd> /// <para> /// To use this operation, you must have permissions to perform the <code>s3:RestoreObject</code> /// action. The bucket owner has this permission by default and can grant this permission /// to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions /// Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing /// Access Permissions to Your Amazon S3 Resources</a> in the <i>Amazon S3 User Guide</i>. /// </para> /// </dd> <dt>Restoring objects</dt> <dd> /// <para> /// Objects that you archive to the S3 Glacier Flexible Retrieval Flexible Retrieval 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 the S3 Glacier /// Flexible Retrieval Flexible Retrieval 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. If you want a permanent copy of the object, create a copy /// of it in the Amazon S3 Standard storage class in your S3 bucket. To access an archived /// object, you must restore the object for the duration (number of days) that you specify. /// For objects in the Archive Access or Deep Archive Access tiers of S3 Intelligent-Tiering, /// you must first initiate a restore request, and then wait until the object is moved /// into the Frequent Access tier. /// </para> /// /// <para> /// 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. /// </para> /// /// <para> /// When restoring an archived object, you can specify one of the following data access /// tier options in the <code>Tier</code> element of the request body: /// </para> /// <ul> <li> /// <para> /// <code>Expedited</code> - Expedited retrievals allow you to quickly access your data /// stored in the S3 Glacier Flexible Retrieval Flexible Retrieval storage class or S3 /// Intelligent-Tiering Archive tier when occasional urgent requests for restoring 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. /// </para> /// </li> <li> /// <para> /// <code>Standard</code> - 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 Flexible Retrieval Flexible Retrieval 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. /// </para> /// </li> <li> /// <para> /// <code>Bulk</code> - Bulk retrievals free for objects stored in the S3 Glacier Flexible /// Retrieval and S3 Intelligent-Tiering storage classes, enabling you to retrieve large /// amounts, even petabytes, of data at no cost. Bulk retrievals typically finish within /// 5–12 hours for objects stored in the S3 Glacier Flexible Retrieval Flexible Retrieval /// storage class or S3 Intelligent-Tiering Archive tier. Bulk retrievals are also the /// lowest-cost retrieval option when restoring objects from S3 Glacier Deep Archive. /// They typically finish within 48 hours for objects stored in the S3 Glacier Deep Archive /// storage class or S3 Intelligent-Tiering Deep Archive tier. /// </para> /// </li> </ul> /// <para> /// For more information about archive retrieval options and provisioned capacity for /// <code>Expedited</code> data access, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html">Restoring /// Archived Objects</a> in the <i>Amazon S3 User Guide</i>. /// </para> /// /// <para> /// 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html#restoring-objects-upgrade-tier.title.html"> /// Upgrading the speed of an in-progress restore</a> in the <i>Amazon S3 User Guide</i>. /// /// </para> /// /// <para> /// To get the status of object restoration, you can send a <code>HEAD</code> request. /// Operations return the <code>x-amz-restore</code> 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 /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html">Configuring /// Amazon S3 Event Notifications</a> in the <i>Amazon S3 User Guide</i>. /// </para> /// /// <para> /// 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. /// </para> /// /// <para> /// 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html">PutBucketLifecycleConfiguration</a> /// and <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html">Object /// Lifecycle Management</a> in <i>Amazon S3 User Guide</i>. /// </para> /// </dd> <dt>Responses</dt> <dd> /// <para> /// A successful action returns either the <code>200 OK</code> or <code>202 Accepted</code> /// status code. /// </para> /// <ul> <li> /// <para> /// If the object is not previously restored, then Amazon S3 returns <code>202 Accepted</code> /// in the response. /// </para> /// </li> <li> /// <para> /// If the object is previously restored, Amazon S3 returns <code>200 OK</code> in the /// response. /// </para> /// </li> </ul> <ul> <li> /// <para> /// Special errors: /// </para> /// <ul> <li> /// <para> /// <i>Code: RestoreAlreadyInProgress</i> /// </para> /// </li> <li> /// <para> /// <i>Cause: Object restore is already in progress. (This error does not apply to SELECT /// type requests.)</i> /// </para> /// </li> <li> /// <para> /// <i>HTTP Status Code: 409 Conflict</i> /// </para> /// </li> <li> /// <para> /// <i>SOAP Fault Code Prefix: Client</i> /// </para> /// </li> </ul> </li> <li> <ul> <li> /// <para> /// <i>Code: GlacierExpeditedRetrievalNotAvailable</i> /// </para> /// </li> <li> /// <para> /// <i>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.)</i> /// </para> /// </li> <li> /// <para> /// <i>HTTP Status Code: 503</i> /// </para> /// </li> <li> /// <para> /// <i>SOAP Fault Code Prefix: N/A</i> /// </para> /// </li> </ul> </li> </ul> </dd> </dl> /// <para> /// The following operations are related to <code>RestoreObject</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html">PutBucketLifecycleConfiguration</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketNotificationConfiguration.html">GetBucketNotificationConfiguration</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the RestoreObject service method.</param> /// /// <returns>The response from the RestoreObject service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/RestoreObject">REST API Reference for RestoreObject Operation</seealso> RestoreObjectResponse RestoreObject(RestoreObjectRequest request); /// <summary> /// Initiates the asynchronous execution of the RestoreObject operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the RestoreObject operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRestoreObject /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/RestoreObject">REST API Reference for RestoreObject Operation</seealso> IAsyncResult BeginRestoreObject(RestoreObjectRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the RestoreObject operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginRestoreObject.</param> /// /// <returns>Returns a RestoreObjectResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/RestoreObject">REST API Reference for RestoreObject Operation</seealso> RestoreObjectResponse EndRestoreObject(IAsyncResult asyncResult); #endregion #region SelectObjectContent /// <summary> /// 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. /// /// /// <para> /// This action is not supported by Amazon S3 on Outposts. /// </para> /// /// <para> /// For more information about Amazon S3 Select, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/selecting-content-from-objects.html">Selecting /// Content from Objects</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-glacier-select-sql-reference-select.html">SELECT /// Command</a> in the <i>Amazon S3 User Guide</i>. /// </para> /// <dl> <dt>Permissions</dt> <dd> /// <para> /// You must have <code>s3:GetObject</code> permission for this operation. Amazon S3 Select /// does not support anonymous access. For more information about permissions, see <a /// href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying /// Permissions in a Policy</a> in the <i>Amazon S3 User Guide</i>. /// </para> /// </dd> <dt>Object Data Formats</dt> <dd> /// <para> /// You can use Amazon S3 Select to query objects that have the following format properties: /// </para> /// <ul> <li> /// <para> /// <i>CSV, JSON, and Parquet</i> - Objects must be in CSV, JSON, or Parquet format. /// </para> /// </li> <li> /// <para> /// <i>UTF-8</i> - UTF-8 is the only encoding type Amazon S3 Select supports. /// </para> /// </li> <li> /// <para> /// <i>GZIP or BZIP2</i> - 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. /// </para> /// </li> <li> /// <para> /// <i>Server-side encryption</i> - Amazon S3 Select supports querying objects that are /// protected with server-side encryption. /// </para> /// /// <para> /// 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a>. /// For more information about SSE-C, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side /// Encryption (Using Customer-Provided Encryption Keys)</a> in the <i>Amazon S3 User /// Guide</i>. /// </para> /// /// <para> /// For objects that are encrypted with Amazon S3 managed 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html">Protecting /// Data Using Server-Side Encryption</a> in the <i>Amazon S3 User Guide</i>. /// </para> /// </li> </ul> </dd> <dt>Working with the Response Body</dt> <dd> /// <para> /// Given the response size is unknown, Amazon S3 Select streams the response as a series /// of messages and includes a <code>Transfer-Encoding</code> header with <code>chunked</code> /// as its value in the response. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTSelectObjectAppendix.html">Appendix: /// SelectObjectContent Response</a>. /// </para> /// </dd> <dt>GetObject Support</dt> <dd> /// <para> /// The <code>SelectObjectContent</code> action does not support the following <code>GetObject</code> /// functionality. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a>. /// </para> /// <ul> <li> /// <para> /// <code>Range</code>: Although you can specify a scan range for an Amazon S3 Select /// request (see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_SelectObjectContent.html#AmazonS3-SelectObjectContent-request-ScanRange">SelectObjectContentRequest /// - ScanRange</a> in the request parameters), you cannot specify the range of bytes /// of an object to return. /// </para> /// </li> <li> /// <para> /// The <code>GLACIER</code>, <code>DEEP_ARCHIVE</code>, and <code>REDUCED_REDUNDANCY</code> /// storage classes, or the <code>ARCHIVE_ACCESS</code> and <code>DEEP_ARCHIVE_ACCESS</code> /// access tiers of the <code>INTELLIGENT_TIERING</code> storage class: You cannot query /// objects in the <code>GLACIER</code>, <code>DEEP_ARCHIVE</code>, or <code>REDUCED_REDUNDANCY</code> /// storage classes, nor objects in the <code>ARCHIVE_ACCESS</code> or <code>DEEP_ARCHIVE_ACCESS</code> /// access tiers of the <code>INTELLIGENT_TIERING</code> storage class. For more information /// about storage classes, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage-class-intro.html">Using /// Amazon S3 storage classes</a> in the <i>Amazon S3 User Guide</i>. /// </para> /// </li> </ul> </dd> <dt>Special Errors</dt> <dd> /// <para> /// For a list of special errors for this operation, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#SelectObjectContentErrorCodeList">List /// of SELECT Object Content Error Codes</a> /// </para> /// </dd> </dl> /// <para> /// The following operations are related to <code>SelectObjectContent</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html">GetBucketLifecycleConfiguration</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html">PutBucketLifecycleConfiguration</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the SelectObjectContent service method.</param> /// /// <returns>The response from the SelectObjectContent service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/SelectObjectContent">REST API Reference for SelectObjectContent Operation</seealso> SelectObjectContentResponse SelectObjectContent(SelectObjectContentRequest request); /// <summary> /// Initiates the asynchronous execution of the SelectObjectContent operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the SelectObjectContent operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSelectObjectContent /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/SelectObjectContent">REST API Reference for SelectObjectContent Operation</seealso> IAsyncResult BeginSelectObjectContent(SelectObjectContentRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the SelectObjectContent operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginSelectObjectContent.</param> /// /// <returns>Returns a SelectObjectContentResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/SelectObjectContent">REST API Reference for SelectObjectContent Operation</seealso> SelectObjectContentResponse EndSelectObjectContent(IAsyncResult asyncResult); #endregion #region UploadPart /// <summary> /// Uploads a part in a multipart upload. /// /// <note> /// <para> /// 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html">UploadPartCopy</a> /// operation. /// </para> /// </note> /// <para> /// You must initiate a multipart upload (see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html">CreateMultipartUpload</a>) /// 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. /// </para> /// /// <para> /// 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. /// </para> /// /// <para> /// For information about maximum and minimum part sizes and other multipart upload specifications, /// see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/qfacts.html">Multipart /// upload limits</a> in the <i>Amazon S3 User Guide</i>. /// </para> /// /// <para> /// To ensure that data is not corrupted when traversing the network, specify the <code>Content-MD5</code> /// 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. /// </para> /// /// <para> /// If the upload request is signed with Signature Version 4, then Amazon Web Services /// S3 uses the <code>x-amz-content-sha256</code> header as a checksum instead of <code>Content-MD5</code>. /// For more information see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-auth-using-authorization-header.html">Authenticating /// Requests: Using the Authorization Header (Amazon Web Services Signature Version 4)</a>. /// /// </para> /// /// <para> /// <b>Note:</b> 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. /// </para> /// /// <para> /// For more information on multipart uploads, go to <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html">Multipart /// Upload Overview</a> in the <i>Amazon S3 User Guide </i>. /// </para> /// /// <para> /// For information on the permissions required to use the multipart upload API, go to /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html">Multipart /// Upload and Permissions</a> in the <i>Amazon S3 User Guide</i>. /// </para> /// /// <para> /// 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. You /// have three mutually exclusive options to protect data using server-side encryption /// in Amazon S3, depending on how you choose to manage the encryption keys. Specifically, /// the encryption key options are Amazon S3 managed keys (SSE-S3), Amazon Web Services /// KMS keys (SSE-KMS), and Customer-Provided Keys (SSE-C). Amazon S3 encrypts data with /// server-side encryption using Amazon S3 managed keys (SSE-S3) by default. You can optionally /// tell Amazon S3 to encrypt data at rest using server-side encryption with other key /// options. The option you use depends on whether you want to use KMS keys (SSE-KMS) /// or provide your own encryption key (SSE-C). 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html">CreateMultipartUpload</a>. /// For more information, go to <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html">Using /// Server-Side Encryption</a> in the <i>Amazon S3 User Guide</i>. /// </para> /// /// <para> /// Server-side encryption is supported by the S3 Multipart Upload actions. Unless you /// are using a customer-provided encryption key (SSE-C), 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html">CreateMultipartUpload</a>. /// </para> /// /// <para> /// If you requested server-side encryption using a customer-provided encryption key (SSE-C) /// in your initiate multipart upload request, you must provide identical encryption information /// in each part upload using the following headers. /// </para> /// <ul> <li> /// <para> /// x-amz-server-side-encryption-customer-algorithm /// </para> /// </li> <li> /// <para> /// x-amz-server-side-encryption-customer-key /// </para> /// </li> <li> /// <para> /// x-amz-server-side-encryption-customer-key-MD5 /// </para> /// </li> </ul> /// <para> /// <code>UploadPart</code> has the following special errors: /// </para> /// <ul> <li> <ul> <li> /// <para> /// <i>Code: NoSuchUpload</i> /// </para> /// </li> <li> /// <para> /// <i>Cause: The specified multipart upload does not exist. The upload ID might be invalid, /// or the multipart upload might have been aborted or completed.</i> /// </para> /// </li> <li> /// <para> /// <i> HTTP Status Code: 404 Not Found </i> /// </para> /// </li> <li> /// <para> /// <i>SOAP Fault Code Prefix: Client</i> /// </para> /// </li> </ul> </li> </ul> /// <para> /// The following operations are related to <code>UploadPart</code>: /// </para> /// <ul> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html">CreateMultipartUpload</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html">CompleteMultipartUpload</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html">AbortMultipartUpload</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html">ListParts</a> /// /// </para> /// </li> <li> /// <para> /// <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html">ListMultipartUploads</a> /// /// </para> /// </li> </ul> /// </summary> /// <param name="request">Container for the necessary parameters to execute the UploadPart service method.</param> /// /// <returns>The response from the UploadPart service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/UploadPart">REST API Reference for UploadPart Operation</seealso> UploadPartResponse UploadPart(UploadPartRequest request); /// <summary> /// Initiates the asynchronous execution of the UploadPart operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the UploadPart operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUploadPart /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/UploadPart">REST API Reference for UploadPart Operation</seealso> IAsyncResult BeginUploadPart(UploadPartRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the UploadPart operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginUploadPart.</param> /// /// <returns>Returns a UploadPartResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/UploadPart">REST API Reference for UploadPart Operation</seealso> UploadPartResponse EndUploadPart(IAsyncResult asyncResult); #endregion #region WriteGetObjectResponse /// <summary> /// Passes transformed objects to a <code>GetObject</code> operation when using Object /// Lambda access points. For information about Object Lambda access points, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/transforming-objects.html">Transforming /// objects with Object Lambda access points</a> in the <i>Amazon S3 User Guide</i>. /// /// /// <para> /// This operation supports metadata that can be returned by <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a>, /// in addition to <code>RequestRoute</code>, <code>RequestToken</code>, <code>StatusCode</code>, /// <code>ErrorCode</code>, and <code>ErrorMessage</code>. The <code>GetObject</code> /// response metadata is supported so that the <code>WriteGetObjectResponse</code> caller, /// typically an Lambda function, can provide the same metadata when it internally invokes /// <code>GetObject</code>. When <code>WriteGetObjectResponse</code> is called by a customer-owned /// Lambda function, the metadata returned to the end user <code>GetObject</code> call /// might differ from what Amazon S3 would normally return. /// </para> /// /// <para> /// You can include any number of metadata headers. When including a metadata header, /// it should be prefaced with <code>x-amz-meta</code>. For example, <code>x-amz-meta-my-custom-header: /// MyCustomValue</code>. The primary use case for this is to forward <code>GetObject</code> /// metadata. /// </para> /// /// <para> /// 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. /// </para> /// /// <para> /// 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. /// </para> /// /// <para> /// 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. /// </para> /// /// <para> /// 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. /// </para> /// /// <para> /// For information on how to view and use these functions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/olap-examples.html">Using /// Amazon Web Services built Lambda functions</a> in the <i>Amazon S3 User Guide</i>. /// </para> /// </summary> /// <param name="request">Container for the necessary parameters to execute the WriteGetObjectResponse service method.</param> /// /// <returns>The response from the WriteGetObjectResponse service method, as returned by S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/WriteGetObjectResponse">REST API Reference for WriteGetObjectResponse Operation</seealso> WriteGetObjectResponseResponse WriteGetObjectResponse(WriteGetObjectResponseRequest request); /// <summary> /// Initiates the asynchronous execution of the WriteGetObjectResponse operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the WriteGetObjectResponse operation on AmazonS3Client.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndWriteGetObjectResponse /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/WriteGetObjectResponse">REST API Reference for WriteGetObjectResponse Operation</seealso> IAsyncResult BeginWriteGetObjectResponse(WriteGetObjectResponseRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the WriteGetObjectResponse operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginWriteGetObjectResponse.</param> /// /// <returns>Returns a WriteGetObjectResponseResult from S3.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/WriteGetObjectResponse">REST API Reference for WriteGetObjectResponse Operation</seealso> WriteGetObjectResponseResponse EndWriteGetObjectResponse(IAsyncResult asyncResult); #endregion } }