/*
* 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.Runtime.ExceptionServices;
using System.Threading;
using System.Threading.Tasks;
using System.Collections.Generic;
using System.Net;
using Amazon.S3.Model;
using Amazon.S3.Model.Internal.MarshallTransformations;
using Amazon.S3.Internal;
using Amazon.Runtime;
using Amazon.Runtime.Internal;
using Amazon.Runtime.Internal.Auth;
using Amazon.Runtime.Internal.Transform;
namespace Amazon.S3
{
///
/// Implementation for accessing S3
///
///
///
public partial class AmazonS3Client : AmazonServiceClient, IAmazonS3
{
private static IServiceMetadata serviceMetadata = new AmazonS3Metadata();
private IS3PaginatorFactory _paginators;
///
/// Paginators for the service
///
public IS3PaginatorFactory Paginators
{
get
{
if (this._paginators == null)
{
this._paginators = new S3PaginatorFactory(this);
}
return this._paginators;
}
}
#region Constructors
///
/// Constructs AmazonS3Client with the credentials loaded from the application's
/// default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
///
/// Example App.config with credentials set.
///
/// <?xml version="1.0" encoding="utf-8" ?>
/// <configuration>
/// <appSettings>
/// <add key="AWSProfileName" value="AWS Default"/>
/// </appSettings>
/// </configuration>
///
///
///
public AmazonS3Client()
: base(FallbackCredentialsFactory.GetCredentials(), new AmazonS3Config()) { }
///
/// Constructs AmazonS3Client with the credentials loaded from the application's
/// default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
///
/// Example App.config with credentials set.
///
/// <?xml version="1.0" encoding="utf-8" ?>
/// <configuration>
/// <appSettings>
/// <add key="AWSProfileName" value="AWS Default"/>
/// </appSettings>
/// </configuration>
///
///
///
/// The region to connect.
public AmazonS3Client(RegionEndpoint region)
: base(FallbackCredentialsFactory.GetCredentials(), new AmazonS3Config{RegionEndpoint = region}) { }
///
/// Constructs AmazonS3Client with the credentials loaded from the application's
/// default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
///
/// Example App.config with credentials set.
///
/// <?xml version="1.0" encoding="utf-8" ?>
/// <configuration>
/// <appSettings>
/// <add key="AWSProfileName" value="AWS Default"/>
/// </appSettings>
/// </configuration>
///
///
///
/// The AmazonS3Client Configuration Object
public AmazonS3Client(AmazonS3Config config)
: base(FallbackCredentialsFactory.GetCredentials(config), config){}
///
/// Constructs AmazonS3Client with AWS Credentials
///
/// AWS Credentials
public AmazonS3Client(AWSCredentials credentials)
: this(credentials, new AmazonS3Config())
{
}
///
/// Constructs AmazonS3Client with AWS Credentials
///
/// AWS Credentials
/// The region to connect.
public AmazonS3Client(AWSCredentials credentials, RegionEndpoint region)
: this(credentials, new AmazonS3Config{RegionEndpoint = region})
{
}
///
/// Constructs AmazonS3Client with AWS Credentials and an
/// AmazonS3Client Configuration object.
///
/// AWS Credentials
/// The AmazonS3Client Configuration Object
public AmazonS3Client(AWSCredentials credentials, AmazonS3Config clientConfig)
: base(credentials, clientConfig)
{
}
///
/// Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key
///
/// AWS Access Key ID
/// AWS Secret Access Key
public AmazonS3Client(string awsAccessKeyId, string awsSecretAccessKey)
: this(awsAccessKeyId, awsSecretAccessKey, new AmazonS3Config())
{
}
///
/// Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key
///
/// AWS Access Key ID
/// AWS Secret Access Key
/// The region to connect.
public AmazonS3Client(string awsAccessKeyId, string awsSecretAccessKey, RegionEndpoint region)
: this(awsAccessKeyId, awsSecretAccessKey, new AmazonS3Config() {RegionEndpoint=region})
{
}
///
/// Constructs AmazonS3Client with AWS Access Key ID, AWS Secret Key and an
/// AmazonS3Client Configuration object.
///
/// AWS Access Key ID
/// AWS Secret Access Key
/// The AmazonS3Client Configuration Object
public AmazonS3Client(string awsAccessKeyId, string awsSecretAccessKey, AmazonS3Config clientConfig)
: base(awsAccessKeyId, awsSecretAccessKey, clientConfig)
{
}
///
/// Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key
///
/// AWS Access Key ID
/// AWS Secret Access Key
/// AWS Session Token
public AmazonS3Client(string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken)
: this(awsAccessKeyId, awsSecretAccessKey, awsSessionToken, new AmazonS3Config())
{
}
///
/// Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key
///
/// AWS Access Key ID
/// AWS Secret Access Key
/// AWS Session Token
/// The region to connect.
public AmazonS3Client(string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, RegionEndpoint region)
: this(awsAccessKeyId, awsSecretAccessKey, awsSessionToken, new AmazonS3Config{RegionEndpoint = region})
{
}
///
/// Constructs AmazonS3Client with AWS Access Key ID, AWS Secret Key and an
/// AmazonS3Client Configuration object.
///
/// AWS Access Key ID
/// AWS Secret Access Key
/// AWS Session Token
/// The AmazonS3Client Configuration Object
public AmazonS3Client(string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, AmazonS3Config clientConfig)
: base(awsAccessKeyId, awsSecretAccessKey, awsSessionToken, clientConfig)
{
}
#endregion
#region Overrides
///
/// Creates the signer for the service.
///
protected override AbstractAWSSigner CreateSigner()
{
return new Amazon.S3.Internal.S3Signer();
}
///
/// Customize the pipeline
///
///
protected override void CustomizeRuntimePipeline(RuntimePipeline pipeline)
{
pipeline.AddHandlerBefore(new Amazon.S3.Internal.AmazonS3PreMarshallHandler());
pipeline.AddHandlerAfter(new Amazon.S3.Internal.AmazonS3KmsHandler());
pipeline.AddHandlerBefore(new Amazon.S3.Internal.AmazonS3ResponseHandler());
pipeline.AddHandlerAfter(new Amazon.S3.Internal.AmazonS3ExceptionHandler());
pipeline.AddHandlerAfter(new Amazon.S3.Internal.AmazonS3RedirectHandler());
if(this.Config.RetryMode == RequestRetryMode.Legacy)
{
pipeline.ReplaceHandler(new Amazon.Runtime.Internal.RetryHandler(new Amazon.S3.Internal.AmazonS3RetryPolicy(this.Config)));
}
if(this.Config.RetryMode == RequestRetryMode.Standard)
{
pipeline.ReplaceHandler(new Amazon.Runtime.Internal.RetryHandler(new Amazon.S3.Internal.AmazonS3StandardRetryPolicy(this.Config)));
}
if(this.Config.RetryMode == RequestRetryMode.Adaptive)
{
pipeline.ReplaceHandler(new Amazon.Runtime.Internal.RetryHandler(new Amazon.S3.Internal.AmazonS3AdaptiveRetryPolicy(this.Config)));
}
pipeline.RemoveHandler();
pipeline.AddHandlerAfter(new AmazonS3EndpointResolver());
}
///
/// Capture metadata for the service.
///
protected override IServiceMetadata ServiceMetadata
{
get
{
return serviceMetadata;
}
}
#endregion
#region Dispose
///
/// Disposes the service client.
///
protected override void Dispose(bool disposing)
{
base.Dispose(disposing);
}
#endregion
#region AbortMultipartUpload
///
/// This action aborts a multipart upload. After a multipart upload is aborted, no additional
/// parts can be uploaded using that upload ID. The storage consumed by any previously
/// uploaded parts will be freed. However, if any part uploads are currently in progress,
/// those part uploads might or might not succeed. As a result, it might be necessary
/// to abort a given multipart upload multiple times in order to completely free all storage
/// consumed by all parts.
///
///
///
/// To verify that all parts have been removed, so you don't get charged for the part
/// storage, you should call the ListParts
/// action and ensure that the parts list is empty.
///
///
///
/// For information about permissions required to use the multipart upload, see Multipart
/// Upload and Permissions.
///
///
///
/// The following operations are related to AbortMultipartUpload:
///
///
///
/// 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 AccessPointName-AccountId.s3-accesspoint.Region.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 Using access points in the Amazon S3 User Guide. 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 AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. 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 What is S3 on Outposts? in the Amazon S3 User Guide.
/// Key of the object for which the multipart upload was initiated.
/// Upload ID that identifies the multipart upload.
///
/// The response from the AbortMultipartUpload service method, as returned by S3.
/// REST API Reference for AbortMultipartUpload Operation
public virtual AbortMultipartUploadResponse AbortMultipartUpload(string bucketName, string key, string uploadId)
{
var request = new AbortMultipartUploadRequest();
request.BucketName = bucketName;
request.Key = key;
request.UploadId = uploadId;
return AbortMultipartUpload(request);
}
///
/// This action aborts a multipart upload. After a multipart upload is aborted, no additional
/// parts can be uploaded using that upload ID. The storage consumed by any previously
/// uploaded parts will be freed. However, if any part uploads are currently in progress,
/// those part uploads might or might not succeed. As a result, it might be necessary
/// to abort a given multipart upload multiple times in order to completely free all storage
/// consumed by all parts.
///
///
///
/// To verify that all parts have been removed, so you don't get charged for the part
/// storage, you should call the ListParts
/// action and ensure that the parts list is empty.
///
///
///
/// For information about permissions required to use the multipart upload, see Multipart
/// Upload and Permissions.
///
///
///
/// The following operations are related to AbortMultipartUpload:
///
///
///
/// Container for the necessary parameters to execute the AbortMultipartUpload service method.
///
/// The response from the AbortMultipartUpload service method, as returned by S3.
/// REST API Reference for AbortMultipartUpload Operation
public virtual AbortMultipartUploadResponse AbortMultipartUpload(AbortMultipartUploadRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = AbortMultipartUploadRequestMarshaller.Instance;
options.ResponseUnmarshaller = AbortMultipartUploadResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// This action aborts a multipart upload. After a multipart upload is aborted, no additional
/// parts can be uploaded using that upload ID. The storage consumed by any previously
/// uploaded parts will be freed. However, if any part uploads are currently in progress,
/// those part uploads might or might not succeed. As a result, it might be necessary
/// to abort a given multipart upload multiple times in order to completely free all storage
/// consumed by all parts.
///
///
///
/// To verify that all parts have been removed, so you don't get charged for the part
/// storage, you should call the ListParts
/// action and ensure that the parts list is empty.
///
///
///
/// For information about permissions required to use the multipart upload, see Multipart
/// Upload and Permissions.
///
///
///
/// The following operations are related to AbortMultipartUpload:
///
///
///
/// 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 AccessPointName-AccountId.s3-accesspoint.Region.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 Using access points in the Amazon S3 User Guide. 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 AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. 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 What is S3 on Outposts? in the Amazon S3 User Guide.
/// Key of the object for which the multipart upload was initiated.
/// Upload ID that identifies the multipart upload.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the AbortMultipartUpload service method, as returned by S3.
/// REST API Reference for AbortMultipartUpload Operation
public virtual Task AbortMultipartUploadAsync(string bucketName, string key, string uploadId, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var request = new AbortMultipartUploadRequest();
request.BucketName = bucketName;
request.Key = key;
request.UploadId = uploadId;
return AbortMultipartUploadAsync(request, cancellationToken);
}
///
/// This action aborts a multipart upload. After a multipart upload is aborted, no additional
/// parts can be uploaded using that upload ID. The storage consumed by any previously
/// uploaded parts will be freed. However, if any part uploads are currently in progress,
/// those part uploads might or might not succeed. As a result, it might be necessary
/// to abort a given multipart upload multiple times in order to completely free all storage
/// consumed by all parts.
///
///
///
/// To verify that all parts have been removed, so you don't get charged for the part
/// storage, you should call the ListParts
/// action and ensure that the parts list is empty.
///
///
///
/// For information about permissions required to use the multipart upload, see Multipart
/// Upload and Permissions.
///
///
///
/// The following operations are related to AbortMultipartUpload:
///
///
///
/// Container for the necessary parameters to execute the AbortMultipartUpload service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the AbortMultipartUpload service method, as returned by S3.
/// REST API Reference for AbortMultipartUpload Operation
public virtual Task AbortMultipartUploadAsync(AbortMultipartUploadRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = AbortMultipartUploadRequestMarshaller.Instance;
options.ResponseUnmarshaller = AbortMultipartUploadResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region CompleteMultipartUpload
///
/// Completes a multipart upload by assembling previously uploaded parts.
///
///
///
/// You first initiate the multipart upload and then upload all parts using the UploadPart
/// operation. After successfully uploading all relevant parts of an upload, you call
/// this action to complete the upload. Upon receiving this request, Amazon S3 concatenates
/// all the parts in ascending order by part number to create a new object. In the Complete
/// Multipart Upload request, you must provide the parts list. You must ensure that the
/// parts list is complete. This action concatenates the parts that you provide in the
/// list. For each part in the list, you must provide the part number and the ETag
/// value, returned after that part was uploaded.
///
///
///
/// Processing of a Complete Multipart Upload request could take several minutes to complete.
/// After Amazon S3 begins processing the request, it sends an HTTP response header that
/// specifies a 200 OK response. While processing is in progress, Amazon S3 periodically
/// sends white space characters to keep the connection from timing out. A request could
/// fail after the initial 200 OK response has been sent. This means that a 200
/// OK 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).
///
///
///
/// Note that if CompleteMultipartUpload fails, applications should be prepared
/// to retry the failed requests. For more information, see Amazon
/// S3 Error Best Practices.
///
///
///
/// You cannot use Content-Type: application/x-www-form-urlencoded with Complete
/// Multipart Upload requests. Also, if you do not provide a Content-Type
/// header, CompleteMultipartUpload returns a 200 OK response.
///
///
///
/// For more information about multipart uploads, see Uploading
/// Objects Using Multipart Upload.
///
///
///
/// For information about permissions required to use the multipart upload API, see Multipart
/// Upload and Permissions.
///
///
///
/// CompleteMultipartUpload has the following special errors:
///
/// -
///
/// Error code:
EntityTooSmall
///
/// -
///
/// Description: Your proposed upload is smaller than the minimum allowed object size.
/// Each part must be at least 5 MB in size, except the last part.
///
///
-
///
/// 400 Bad Request
///
///
-
///
/// Error code:
InvalidPart
///
/// -
///
/// Description: One or more of the specified parts could not be found. The part might
/// not have been uploaded, or the specified entity tag might not have matched the part's
/// entity tag.
///
///
-
///
/// 400 Bad Request
///
///
-
///
/// Error code:
InvalidPartOrder
///
/// -
///
/// Description: The list of parts was not in ascending order. The parts list must be
/// specified in order by part number.
///
///
-
///
/// 400 Bad Request
///
///
-
///
/// Error code:
NoSuchUpload
///
/// -
///
/// Description: The specified multipart upload does not exist. The upload ID might be
/// invalid, or the multipart upload might have been aborted or completed.
///
///
-
///
/// 404 Not Found
///
///
///
/// The following operations are related to CompleteMultipartUpload:
///
///
///
/// Container for the necessary parameters to execute the CompleteMultipartUpload service method.
///
/// The response from the CompleteMultipartUpload service method, as returned by S3.
/// REST API Reference for CompleteMultipartUpload Operation
public virtual CompleteMultipartUploadResponse CompleteMultipartUpload(CompleteMultipartUploadRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = CompleteMultipartUploadRequestMarshaller.Instance;
options.ResponseUnmarshaller = CompleteMultipartUploadResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Completes a multipart upload by assembling previously uploaded parts.
///
///
///
/// You first initiate the multipart upload and then upload all parts using the UploadPart
/// operation. After successfully uploading all relevant parts of an upload, you call
/// this action to complete the upload. Upon receiving this request, Amazon S3 concatenates
/// all the parts in ascending order by part number to create a new object. In the Complete
/// Multipart Upload request, you must provide the parts list. You must ensure that the
/// parts list is complete. This action concatenates the parts that you provide in the
/// list. For each part in the list, you must provide the part number and the ETag
/// value, returned after that part was uploaded.
///
///
///
/// Processing of a Complete Multipart Upload request could take several minutes to complete.
/// After Amazon S3 begins processing the request, it sends an HTTP response header that
/// specifies a 200 OK response. While processing is in progress, Amazon S3 periodically
/// sends white space characters to keep the connection from timing out. A request could
/// fail after the initial 200 OK response has been sent. This means that a 200
/// OK 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).
///
///
///
/// Note that if CompleteMultipartUpload fails, applications should be prepared
/// to retry the failed requests. For more information, see Amazon
/// S3 Error Best Practices.
///
///
///
/// You cannot use Content-Type: application/x-www-form-urlencoded with Complete
/// Multipart Upload requests. Also, if you do not provide a Content-Type
/// header, CompleteMultipartUpload returns a 200 OK response.
///
///
///
/// For more information about multipart uploads, see Uploading
/// Objects Using Multipart Upload.
///
///
///
/// For information about permissions required to use the multipart upload API, see Multipart
/// Upload and Permissions.
///
///
///
/// CompleteMultipartUpload has the following special errors:
///
/// -
///
/// Error code:
EntityTooSmall
///
/// -
///
/// Description: Your proposed upload is smaller than the minimum allowed object size.
/// Each part must be at least 5 MB in size, except the last part.
///
///
-
///
/// 400 Bad Request
///
///
-
///
/// Error code:
InvalidPart
///
/// -
///
/// Description: One or more of the specified parts could not be found. The part might
/// not have been uploaded, or the specified entity tag might not have matched the part's
/// entity tag.
///
///
-
///
/// 400 Bad Request
///
///
-
///
/// Error code:
InvalidPartOrder
///
/// -
///
/// Description: The list of parts was not in ascending order. The parts list must be
/// specified in order by part number.
///
///
-
///
/// 400 Bad Request
///
///
-
///
/// Error code:
NoSuchUpload
///
/// -
///
/// Description: The specified multipart upload does not exist. The upload ID might be
/// invalid, or the multipart upload might have been aborted or completed.
///
///
-
///
/// 404 Not Found
///
///
///
/// The following operations are related to CompleteMultipartUpload:
///
///
///
/// Container for the necessary parameters to execute the CompleteMultipartUpload service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CompleteMultipartUpload service method, as returned by S3.
/// REST API Reference for CompleteMultipartUpload Operation
public virtual Task CompleteMultipartUploadAsync(CompleteMultipartUploadRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = CompleteMultipartUploadRequestMarshaller.Instance;
options.ResponseUnmarshaller = CompleteMultipartUploadResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region CopyObject
///
/// Creates a copy of an object that is already stored in Amazon S3.
///
///
///
/// You can store individual objects of up to 5 TB in Amazon S3. You create a copy of
/// your object up to 5 GB in size in a single atomic action using this API. However,
/// to copy an object greater than 5 GB, you must use the multipart upload Upload Part
/// - Copy (UploadPartCopy) API. For more information, see Copy
/// Object Using the REST Multipart Upload API.
///
///
///
/// All copy requests must be authenticated. Additionally, you must have read access
/// to the source object and write access to the destination bucket. For more information,
/// see REST
/// Authentication. Both the Region that you want to copy the object from and the
/// Region that you want to copy the object to must be enabled for your account.
///
///
///
/// A copy request might return an error when Amazon S3 receives the copy request or while
/// Amazon S3 is copying the files. If the error occurs before the copy action starts,
/// you receive a standard Amazon S3 error. If the error occurs during the copy operation,
/// the error response is embedded in the 200 OK response. This means that
/// a 200 OK response can contain either a success or an error. 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).
///
///
///
/// If the copy is successful, you receive a response with information about the copied
/// object.
///
///
///
/// 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.
///
///
///
/// 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 Amazon S3 pricing.
///
///
///
/// Amazon S3 transfer acceleration does not support cross-Region copies. If you request
/// a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad
/// Request error. For more information, see Transfer
/// Acceleration.
///
/// - Metadata
-
///
/// When copying an object, you can preserve all metadata (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 Using
/// ACLs.
///
///
///
/// To specify whether you want the object metadata copied from the source object or replaced
/// with metadata provided in the request, you can optionally add the
x-amz-metadata-directive
/// header. When you grant permissions, you can use the s3:x-amz-metadata-directive
/// condition key to enforce certain metadata behavior when objects are uploaded. For
/// more information, see Specifying
/// Conditions in a Policy in the Amazon S3 User Guide. For a complete list
/// of Amazon S3-specific condition keys, see Actions,
/// Resources, and Condition Keys for Amazon S3.
///
///
///
/// x-amz-website-redirect-location is unique to each object and must be
/// specified in the request headers to copy the value.
///
/// - x-amz-copy-source-if Headers
-
///
/// To only copy an object under certain conditions, such as whether the
Etag
/// matches or whether the object was modified before or after a specified date, use the
/// following request parameters:
///
/// -
///
///
x-amz-copy-source-if-match
///
/// -
///
///
x-amz-copy-source-if-none-match
///
/// -
///
///
x-amz-copy-source-if-unmodified-since
///
/// -
///
///
x-amz-copy-source-if-modified-since
///
///
///
/// If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since
/// headers are present in the request and evaluate as follows, Amazon S3 returns 200
/// OK and copies the data:
///
/// -
///
///
x-amz-copy-source-if-match condition evaluates to true
///
/// -
///
///
x-amz-copy-source-if-unmodified-since condition evaluates to false
///
///
///
/// If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since
/// headers are present in the request and evaluate as follows, Amazon S3 returns the
/// 412 Precondition Failed response code:
///
/// -
///
///
x-amz-copy-source-if-none-match condition evaluates to false
///
/// -
///
///
x-amz-copy-source-if-modified-since condition evaluates to true
///
///
///
/// All headers with the x-amz- prefix, including x-amz-copy-source,
/// must be signed.
///
/// - Server-side encryption
-
///
/// 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.
///
///
///
/// When you perform a
CopyObject 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 Using
/// Server-Side Encryption.
///
///
///
/// If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object. For
/// more information, see Amazon
/// S3 Bucket Keys in the Amazon S3 User Guide.
///
/// - Access Control List (ACL)-Specific Request Headers
-
///
/// When copying an object, you can optionally use headers to grant ACL-based permissions.
/// By default, all objects are private. Only the owner has full access control. When
/// adding a new object, you can grant permissions to individual Amazon Web Services accounts
/// or to predefined groups that are defined by Amazon S3. These permissions are then
/// added to the ACL on the object. For more information, see Access
/// Control List (ACL) Overview and Managing
/// ACLs Using the REST API.
///
///
///
/// If the bucket that you're copying objects to uses the bucket owner enforced setting
/// for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets
/// that use this setting only accept
PUT requests that don't specify an
/// ACL or PUT requests that specify bucket owner full control ACLs, such
/// as the bucket-owner-full-control canned ACL or an equivalent form of
/// this ACL expressed in the XML format.
///
///
///
/// For more information, see
/// Controlling ownership of objects and disabling ACLs in the Amazon S3 User Guide.
///
///
///
/// 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.
///
/// - Checksums
-
///
/// When copying an object, if it has a checksum, that checksum will be copied to the
/// new object by default. When you copy the object over, you can optionally specify a
/// different checksum algorithm to use with the
x-amz-checksum-algorithm
/// header.
///
/// - Storage Class Options
-
///
/// You can use the
CopyObject action to change the storage class of an object
/// that is already stored in Amazon S3 by using the StorageClass parameter.
/// For more information, see Storage
/// Classes in the Amazon S3 User Guide.
///
///
///
/// If the source object's storage class is GLACIER or DEEP_ARCHIVE, or the object's storage
/// class is INTELLIGENT_TIERING and it's
/// S3 Intelligent-Tiering access tier is Archive Access or Deep Archive Access, you
/// must restore a copy of this object before you can use it as a source object for the
/// copy operation. For more information, see RestoreObject.
/// For more information, see Copying
/// Objects.
///
/// - Versioning
-
///
/// By default,
x-amz-copy-source 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 versionId
/// subresource.
///
///
///
/// If you enable versioning on the target bucket, Amazon S3 generates a unique version
/// ID for the object being copied. This version ID is different from the version ID of
/// the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id
/// response header in the response.
///
///
///
/// If you do not enable versioning or suspend it on the target bucket, the version ID
/// that Amazon S3 generates is always null.
///
///
///
/// The following operations are related to CopyObject:
///
///
///
/// A property of CopyObjectRequest used to execute the CopyObject service method.
/// A property of CopyObjectRequest used to execute the CopyObject service method.
/// 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 AccessPointName-AccountId.s3-accesspoint.Region.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 Using access points in the Amazon S3 User Guide. 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 AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. 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 What is S3 on Outposts? in the Amazon S3 User Guide.
/// A property of CopyObjectRequest used to execute the CopyObject service method.
///
/// The response from the CopyObject service method, as returned by S3.
/// REST API Reference for CopyObject Operation
public virtual CopyObjectResponse CopyObject(string sourceBucket, string sourceKey, string destinationBucket, string destinationKey)
{
var request = new CopyObjectRequest();
request.SourceBucket = sourceBucket;
request.SourceKey = sourceKey;
request.DestinationBucket = destinationBucket;
request.DestinationKey = destinationKey;
return CopyObject(request);
}
///
/// Creates a copy of an object that is already stored in Amazon S3.
///
///
///
/// You can store individual objects of up to 5 TB in Amazon S3. You create a copy of
/// your object up to 5 GB in size in a single atomic action using this API. However,
/// to copy an object greater than 5 GB, you must use the multipart upload Upload Part
/// - Copy (UploadPartCopy) API. For more information, see Copy
/// Object Using the REST Multipart Upload API.
///
///
///
/// All copy requests must be authenticated. Additionally, you must have read access
/// to the source object and write access to the destination bucket. For more information,
/// see REST
/// Authentication. Both the Region that you want to copy the object from and the
/// Region that you want to copy the object to must be enabled for your account.
///
///
///
/// A copy request might return an error when Amazon S3 receives the copy request or while
/// Amazon S3 is copying the files. If the error occurs before the copy action starts,
/// you receive a standard Amazon S3 error. If the error occurs during the copy operation,
/// the error response is embedded in the 200 OK response. This means that
/// a 200 OK response can contain either a success or an error. 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).
///
///
///
/// If the copy is successful, you receive a response with information about the copied
/// object.
///
///
///
/// 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.
///
///
///
/// 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 Amazon S3 pricing.
///
///
///
/// Amazon S3 transfer acceleration does not support cross-Region copies. If you request
/// a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad
/// Request error. For more information, see Transfer
/// Acceleration.
///
/// - Metadata
-
///
/// When copying an object, you can preserve all metadata (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 Using
/// ACLs.
///
///
///
/// To specify whether you want the object metadata copied from the source object or replaced
/// with metadata provided in the request, you can optionally add the
x-amz-metadata-directive
/// header. When you grant permissions, you can use the s3:x-amz-metadata-directive
/// condition key to enforce certain metadata behavior when objects are uploaded. For
/// more information, see Specifying
/// Conditions in a Policy in the Amazon S3 User Guide. For a complete list
/// of Amazon S3-specific condition keys, see Actions,
/// Resources, and Condition Keys for Amazon S3.
///
///
///
/// x-amz-website-redirect-location is unique to each object and must be
/// specified in the request headers to copy the value.
///
/// - x-amz-copy-source-if Headers
-
///
/// To only copy an object under certain conditions, such as whether the
Etag
/// matches or whether the object was modified before or after a specified date, use the
/// following request parameters:
///
/// -
///
///
x-amz-copy-source-if-match
///
/// -
///
///
x-amz-copy-source-if-none-match
///
/// -
///
///
x-amz-copy-source-if-unmodified-since
///
/// -
///
///
x-amz-copy-source-if-modified-since
///
///
///
/// If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since
/// headers are present in the request and evaluate as follows, Amazon S3 returns 200
/// OK and copies the data:
///
/// -
///
///
x-amz-copy-source-if-match condition evaluates to true
///
/// -
///
///
x-amz-copy-source-if-unmodified-since condition evaluates to false
///
///
///
/// If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since
/// headers are present in the request and evaluate as follows, Amazon S3 returns the
/// 412 Precondition Failed response code:
///
/// -
///
///
x-amz-copy-source-if-none-match condition evaluates to false
///
/// -
///
///
x-amz-copy-source-if-modified-since condition evaluates to true
///
///
///
/// All headers with the x-amz- prefix, including x-amz-copy-source,
/// must be signed.
///
/// - Server-side encryption
-
///
/// 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.
///
///
///
/// When you perform a
CopyObject 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 Using
/// Server-Side Encryption.
///
///
///
/// If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object. For
/// more information, see Amazon
/// S3 Bucket Keys in the Amazon S3 User Guide.
///
/// - Access Control List (ACL)-Specific Request Headers
-
///
/// When copying an object, you can optionally use headers to grant ACL-based permissions.
/// By default, all objects are private. Only the owner has full access control. When
/// adding a new object, you can grant permissions to individual Amazon Web Services accounts
/// or to predefined groups that are defined by Amazon S3. These permissions are then
/// added to the ACL on the object. For more information, see Access
/// Control List (ACL) Overview and Managing
/// ACLs Using the REST API.
///
///
///
/// If the bucket that you're copying objects to uses the bucket owner enforced setting
/// for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets
/// that use this setting only accept
PUT requests that don't specify an
/// ACL or PUT requests that specify bucket owner full control ACLs, such
/// as the bucket-owner-full-control canned ACL or an equivalent form of
/// this ACL expressed in the XML format.
///
///
///
/// For more information, see
/// Controlling ownership of objects and disabling ACLs in the Amazon S3 User Guide.
///
///
///
/// 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.
///
/// - Checksums
-
///
/// When copying an object, if it has a checksum, that checksum will be copied to the
/// new object by default. When you copy the object over, you can optionally specify a
/// different checksum algorithm to use with the
x-amz-checksum-algorithm
/// header.
///
/// - Storage Class Options
-
///
/// You can use the
CopyObject action to change the storage class of an object
/// that is already stored in Amazon S3 by using the StorageClass parameter.
/// For more information, see Storage
/// Classes in the Amazon S3 User Guide.
///
///
///
/// If the source object's storage class is GLACIER or DEEP_ARCHIVE, or the object's storage
/// class is INTELLIGENT_TIERING and it's
/// S3 Intelligent-Tiering access tier is Archive Access or Deep Archive Access, you
/// must restore a copy of this object before you can use it as a source object for the
/// copy operation. For more information, see RestoreObject.
/// For more information, see Copying
/// Objects.
///
/// - Versioning
-
///
/// By default,
x-amz-copy-source 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 versionId
/// subresource.
///
///
///
/// If you enable versioning on the target bucket, Amazon S3 generates a unique version
/// ID for the object being copied. This version ID is different from the version ID of
/// the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id
/// response header in the response.
///
///
///
/// If you do not enable versioning or suspend it on the target bucket, the version ID
/// that Amazon S3 generates is always null.
///
///
///
/// The following operations are related to CopyObject:
///
///
///
/// A property of CopyObjectRequest used to execute the CopyObject service method.
/// A property of CopyObjectRequest used to execute the CopyObject service method.
/// A property of CopyObjectRequest used to execute the CopyObject service method.
/// 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 AccessPointName-AccountId.s3-accesspoint.Region.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 Using access points in the Amazon S3 User Guide. 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 AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. 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 What is S3 on Outposts? in the Amazon S3 User Guide.
/// A property of CopyObjectRequest used to execute the CopyObject service method.
///
/// The response from the CopyObject service method, as returned by S3.
/// REST API Reference for CopyObject Operation
public virtual CopyObjectResponse CopyObject(string sourceBucket, string sourceKey, string sourceVersionId, string destinationBucket, string destinationKey)
{
var request = new CopyObjectRequest();
request.SourceBucket = sourceBucket;
request.SourceKey = sourceKey;
request.SourceVersionId = sourceVersionId;
request.DestinationBucket = destinationBucket;
request.DestinationKey = destinationKey;
return CopyObject(request);
}
///
/// Creates a copy of an object that is already stored in Amazon S3.
///
///
///
/// You can store individual objects of up to 5 TB in Amazon S3. You create a copy of
/// your object up to 5 GB in size in a single atomic action using this API. However,
/// to copy an object greater than 5 GB, you must use the multipart upload Upload Part
/// - Copy (UploadPartCopy) API. For more information, see Copy
/// Object Using the REST Multipart Upload API.
///
///
///
/// All copy requests must be authenticated. Additionally, you must have read access
/// to the source object and write access to the destination bucket. For more information,
/// see REST
/// Authentication. Both the Region that you want to copy the object from and the
/// Region that you want to copy the object to must be enabled for your account.
///
///
///
/// A copy request might return an error when Amazon S3 receives the copy request or while
/// Amazon S3 is copying the files. If the error occurs before the copy action starts,
/// you receive a standard Amazon S3 error. If the error occurs during the copy operation,
/// the error response is embedded in the 200 OK response. This means that
/// a 200 OK response can contain either a success or an error. 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).
///
///
///
/// If the copy is successful, you receive a response with information about the copied
/// object.
///
///
///
/// 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.
///
///
///
/// 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 Amazon S3 pricing.
///
///
///
/// Amazon S3 transfer acceleration does not support cross-Region copies. If you request
/// a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad
/// Request error. For more information, see Transfer
/// Acceleration.
///
/// - Metadata
-
///
/// When copying an object, you can preserve all metadata (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 Using
/// ACLs.
///
///
///
/// To specify whether you want the object metadata copied from the source object or replaced
/// with metadata provided in the request, you can optionally add the
x-amz-metadata-directive
/// header. When you grant permissions, you can use the s3:x-amz-metadata-directive
/// condition key to enforce certain metadata behavior when objects are uploaded. For
/// more information, see Specifying
/// Conditions in a Policy in the Amazon S3 User Guide. For a complete list
/// of Amazon S3-specific condition keys, see Actions,
/// Resources, and Condition Keys for Amazon S3.
///
///
///
/// x-amz-website-redirect-location is unique to each object and must be
/// specified in the request headers to copy the value.
///
/// - x-amz-copy-source-if Headers
-
///
/// To only copy an object under certain conditions, such as whether the
Etag
/// matches or whether the object was modified before or after a specified date, use the
/// following request parameters:
///
/// -
///
///
x-amz-copy-source-if-match
///
/// -
///
///
x-amz-copy-source-if-none-match
///
/// -
///
///
x-amz-copy-source-if-unmodified-since
///
/// -
///
///
x-amz-copy-source-if-modified-since
///
///
///
/// If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since
/// headers are present in the request and evaluate as follows, Amazon S3 returns 200
/// OK and copies the data:
///
/// -
///
///
x-amz-copy-source-if-match condition evaluates to true
///
/// -
///
///
x-amz-copy-source-if-unmodified-since condition evaluates to false
///
///
///
/// If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since
/// headers are present in the request and evaluate as follows, Amazon S3 returns the
/// 412 Precondition Failed response code:
///
/// -
///
///
x-amz-copy-source-if-none-match condition evaluates to false
///
/// -
///
///
x-amz-copy-source-if-modified-since condition evaluates to true
///
///
///
/// All headers with the x-amz- prefix, including x-amz-copy-source,
/// must be signed.
///
/// - Server-side encryption
-
///
/// 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.
///
///
///
/// When you perform a
CopyObject 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 Using
/// Server-Side Encryption.
///
///
///
/// If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object. For
/// more information, see Amazon
/// S3 Bucket Keys in the Amazon S3 User Guide.
///
/// - Access Control List (ACL)-Specific Request Headers
-
///
/// When copying an object, you can optionally use headers to grant ACL-based permissions.
/// By default, all objects are private. Only the owner has full access control. When
/// adding a new object, you can grant permissions to individual Amazon Web Services accounts
/// or to predefined groups that are defined by Amazon S3. These permissions are then
/// added to the ACL on the object. For more information, see Access
/// Control List (ACL) Overview and Managing
/// ACLs Using the REST API.
///
///
///
/// If the bucket that you're copying objects to uses the bucket owner enforced setting
/// for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets
/// that use this setting only accept
PUT requests that don't specify an
/// ACL or PUT requests that specify bucket owner full control ACLs, such
/// as the bucket-owner-full-control canned ACL or an equivalent form of
/// this ACL expressed in the XML format.
///
///
///
/// For more information, see
/// Controlling ownership of objects and disabling ACLs in the Amazon S3 User Guide.
///
///
///
/// 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.
///
/// - Checksums
-
///
/// When copying an object, if it has a checksum, that checksum will be copied to the
/// new object by default. When you copy the object over, you can optionally specify a
/// different checksum algorithm to use with the
x-amz-checksum-algorithm
/// header.
///
/// - Storage Class Options
-
///
/// You can use the
CopyObject action to change the storage class of an object
/// that is already stored in Amazon S3 by using the StorageClass parameter.
/// For more information, see Storage
/// Classes in the Amazon S3 User Guide.
///
///
///
/// If the source object's storage class is GLACIER or DEEP_ARCHIVE, or the object's storage
/// class is INTELLIGENT_TIERING and it's
/// S3 Intelligent-Tiering access tier is Archive Access or Deep Archive Access, you
/// must restore a copy of this object before you can use it as a source object for the
/// copy operation. For more information, see RestoreObject.
/// For more information, see Copying
/// Objects.
///
/// - Versioning
-
///
/// By default,
x-amz-copy-source 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 versionId
/// subresource.
///
///
///
/// If you enable versioning on the target bucket, Amazon S3 generates a unique version
/// ID for the object being copied. This version ID is different from the version ID of
/// the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id
/// response header in the response.
///
///
///
/// If you do not enable versioning or suspend it on the target bucket, the version ID
/// that Amazon S3 generates is always null.
///
///
///
/// The following operations are related to CopyObject:
///
///
///
/// Container for the necessary parameters to execute the CopyObject service method.
///
/// The response from the CopyObject service method, as returned by S3.
/// REST API Reference for CopyObject Operation
public virtual CopyObjectResponse CopyObject(CopyObjectRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = CopyObjectRequestMarshaller.Instance;
options.ResponseUnmarshaller = CopyObjectResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Creates a copy of an object that is already stored in Amazon S3.
///
///
///
/// You can store individual objects of up to 5 TB in Amazon S3. You create a copy of
/// your object up to 5 GB in size in a single atomic action using this API. However,
/// to copy an object greater than 5 GB, you must use the multipart upload Upload Part
/// - Copy (UploadPartCopy) API. For more information, see Copy
/// Object Using the REST Multipart Upload API.
///
///
///
/// All copy requests must be authenticated. Additionally, you must have read access
/// to the source object and write access to the destination bucket. For more information,
/// see REST
/// Authentication. Both the Region that you want to copy the object from and the
/// Region that you want to copy the object to must be enabled for your account.
///
///
///
/// A copy request might return an error when Amazon S3 receives the copy request or while
/// Amazon S3 is copying the files. If the error occurs before the copy action starts,
/// you receive a standard Amazon S3 error. If the error occurs during the copy operation,
/// the error response is embedded in the 200 OK response. This means that
/// a 200 OK response can contain either a success or an error. 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).
///
///
///
/// If the copy is successful, you receive a response with information about the copied
/// object.
///
///
///
/// 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.
///
///
///
/// 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 Amazon S3 pricing.
///
///
///
/// Amazon S3 transfer acceleration does not support cross-Region copies. If you request
/// a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad
/// Request error. For more information, see Transfer
/// Acceleration.
///
/// - Metadata
-
///
/// When copying an object, you can preserve all metadata (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 Using
/// ACLs.
///
///
///
/// To specify whether you want the object metadata copied from the source object or replaced
/// with metadata provided in the request, you can optionally add the
x-amz-metadata-directive
/// header. When you grant permissions, you can use the s3:x-amz-metadata-directive
/// condition key to enforce certain metadata behavior when objects are uploaded. For
/// more information, see Specifying
/// Conditions in a Policy in the Amazon S3 User Guide. For a complete list
/// of Amazon S3-specific condition keys, see Actions,
/// Resources, and Condition Keys for Amazon S3.
///
///
///
/// x-amz-website-redirect-location is unique to each object and must be
/// specified in the request headers to copy the value.
///
/// - x-amz-copy-source-if Headers
-
///
/// To only copy an object under certain conditions, such as whether the
Etag
/// matches or whether the object was modified before or after a specified date, use the
/// following request parameters:
///
/// -
///
///
x-amz-copy-source-if-match
///
/// -
///
///
x-amz-copy-source-if-none-match
///
/// -
///
///
x-amz-copy-source-if-unmodified-since
///
/// -
///
///
x-amz-copy-source-if-modified-since
///
///
///
/// If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since
/// headers are present in the request and evaluate as follows, Amazon S3 returns 200
/// OK and copies the data:
///
/// -
///
///
x-amz-copy-source-if-match condition evaluates to true
///
/// -
///
///
x-amz-copy-source-if-unmodified-since condition evaluates to false
///
///
///
/// If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since
/// headers are present in the request and evaluate as follows, Amazon S3 returns the
/// 412 Precondition Failed response code:
///
/// -
///
///
x-amz-copy-source-if-none-match condition evaluates to false
///
/// -
///
///
x-amz-copy-source-if-modified-since condition evaluates to true
///
///
///
/// All headers with the x-amz- prefix, including x-amz-copy-source,
/// must be signed.
///
/// - Server-side encryption
-
///
/// 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.
///
///
///
/// When you perform a
CopyObject 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 Using
/// Server-Side Encryption.
///
///
///
/// If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object. For
/// more information, see Amazon
/// S3 Bucket Keys in the Amazon S3 User Guide.
///
/// - Access Control List (ACL)-Specific Request Headers
-
///
/// When copying an object, you can optionally use headers to grant ACL-based permissions.
/// By default, all objects are private. Only the owner has full access control. When
/// adding a new object, you can grant permissions to individual Amazon Web Services accounts
/// or to predefined groups that are defined by Amazon S3. These permissions are then
/// added to the ACL on the object. For more information, see Access
/// Control List (ACL) Overview and Managing
/// ACLs Using the REST API.
///
///
///
/// If the bucket that you're copying objects to uses the bucket owner enforced setting
/// for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets
/// that use this setting only accept
PUT requests that don't specify an
/// ACL or PUT requests that specify bucket owner full control ACLs, such
/// as the bucket-owner-full-control canned ACL or an equivalent form of
/// this ACL expressed in the XML format.
///
///
///
/// For more information, see
/// Controlling ownership of objects and disabling ACLs in the Amazon S3 User Guide.
///
///
///
/// 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.
///
/// - Checksums
-
///
/// When copying an object, if it has a checksum, that checksum will be copied to the
/// new object by default. When you copy the object over, you can optionally specify a
/// different checksum algorithm to use with the
x-amz-checksum-algorithm
/// header.
///
/// - Storage Class Options
-
///
/// You can use the
CopyObject action to change the storage class of an object
/// that is already stored in Amazon S3 by using the StorageClass parameter.
/// For more information, see Storage
/// Classes in the Amazon S3 User Guide.
///
///
///
/// If the source object's storage class is GLACIER or DEEP_ARCHIVE, or the object's storage
/// class is INTELLIGENT_TIERING and it's
/// S3 Intelligent-Tiering access tier is Archive Access or Deep Archive Access, you
/// must restore a copy of this object before you can use it as a source object for the
/// copy operation. For more information, see RestoreObject.
/// For more information, see Copying
/// Objects.
///
/// - Versioning
-
///
/// By default,
x-amz-copy-source 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 versionId
/// subresource.
///
///
///
/// If you enable versioning on the target bucket, Amazon S3 generates a unique version
/// ID for the object being copied. This version ID is different from the version ID of
/// the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id
/// response header in the response.
///
///
///
/// If you do not enable versioning or suspend it on the target bucket, the version ID
/// that Amazon S3 generates is always null.
///
///
///
/// The following operations are related to CopyObject:
///
///
///
/// A property of CopyObjectRequest used to execute the CopyObject service method.
/// A property of CopyObjectRequest used to execute the CopyObject service method.
/// 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 AccessPointName-AccountId.s3-accesspoint.Region.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 Using access points in the Amazon S3 User Guide. 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 AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. 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 What is S3 on Outposts? in the Amazon S3 User Guide.
/// A property of CopyObjectRequest used to execute the CopyObject service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CopyObject service method, as returned by S3.
/// REST API Reference for CopyObject Operation
public virtual Task CopyObjectAsync(string sourceBucket, string sourceKey, string destinationBucket, string destinationKey, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var request = new CopyObjectRequest();
request.SourceBucket = sourceBucket;
request.SourceKey = sourceKey;
request.DestinationBucket = destinationBucket;
request.DestinationKey = destinationKey;
return CopyObjectAsync(request, cancellationToken);
}
///
/// Creates a copy of an object that is already stored in Amazon S3.
///
///
///
/// You can store individual objects of up to 5 TB in Amazon S3. You create a copy of
/// your object up to 5 GB in size in a single atomic action using this API. However,
/// to copy an object greater than 5 GB, you must use the multipart upload Upload Part
/// - Copy (UploadPartCopy) API. For more information, see Copy
/// Object Using the REST Multipart Upload API.
///
///
///
/// All copy requests must be authenticated. Additionally, you must have read access
/// to the source object and write access to the destination bucket. For more information,
/// see REST
/// Authentication. Both the Region that you want to copy the object from and the
/// Region that you want to copy the object to must be enabled for your account.
///
///
///
/// A copy request might return an error when Amazon S3 receives the copy request or while
/// Amazon S3 is copying the files. If the error occurs before the copy action starts,
/// you receive a standard Amazon S3 error. If the error occurs during the copy operation,
/// the error response is embedded in the 200 OK response. This means that
/// a 200 OK response can contain either a success or an error. 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).
///
///
///
/// If the copy is successful, you receive a response with information about the copied
/// object.
///
///
///
/// 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.
///
///
///
/// 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 Amazon S3 pricing.
///
///
///
/// Amazon S3 transfer acceleration does not support cross-Region copies. If you request
/// a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad
/// Request error. For more information, see Transfer
/// Acceleration.
///
/// - Metadata
-
///
/// When copying an object, you can preserve all metadata (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 Using
/// ACLs.
///
///
///
/// To specify whether you want the object metadata copied from the source object or replaced
/// with metadata provided in the request, you can optionally add the
x-amz-metadata-directive
/// header. When you grant permissions, you can use the s3:x-amz-metadata-directive
/// condition key to enforce certain metadata behavior when objects are uploaded. For
/// more information, see Specifying
/// Conditions in a Policy in the Amazon S3 User Guide. For a complete list
/// of Amazon S3-specific condition keys, see Actions,
/// Resources, and Condition Keys for Amazon S3.
///
///
///
/// x-amz-website-redirect-location is unique to each object and must be
/// specified in the request headers to copy the value.
///
/// - x-amz-copy-source-if Headers
-
///
/// To only copy an object under certain conditions, such as whether the
Etag
/// matches or whether the object was modified before or after a specified date, use the
/// following request parameters:
///
/// -
///
///
x-amz-copy-source-if-match
///
/// -
///
///
x-amz-copy-source-if-none-match
///
/// -
///
///
x-amz-copy-source-if-unmodified-since
///
/// -
///
///
x-amz-copy-source-if-modified-since
///
///
///
/// If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since
/// headers are present in the request and evaluate as follows, Amazon S3 returns 200
/// OK and copies the data:
///
/// -
///
///
x-amz-copy-source-if-match condition evaluates to true
///
/// -
///
///
x-amz-copy-source-if-unmodified-since condition evaluates to false
///
///
///
/// If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since
/// headers are present in the request and evaluate as follows, Amazon S3 returns the
/// 412 Precondition Failed response code:
///
/// -
///
///
x-amz-copy-source-if-none-match condition evaluates to false
///
/// -
///
///
x-amz-copy-source-if-modified-since condition evaluates to true
///
///
///
/// All headers with the x-amz- prefix, including x-amz-copy-source,
/// must be signed.
///
/// - Server-side encryption
-
///
/// 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.
///
///
///
/// When you perform a
CopyObject 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 Using
/// Server-Side Encryption.
///
///
///
/// If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object. For
/// more information, see Amazon
/// S3 Bucket Keys in the Amazon S3 User Guide.
///
/// - Access Control List (ACL)-Specific Request Headers
-
///
/// When copying an object, you can optionally use headers to grant ACL-based permissions.
/// By default, all objects are private. Only the owner has full access control. When
/// adding a new object, you can grant permissions to individual Amazon Web Services accounts
/// or to predefined groups that are defined by Amazon S3. These permissions are then
/// added to the ACL on the object. For more information, see Access
/// Control List (ACL) Overview and Managing
/// ACLs Using the REST API.
///
///
///
/// If the bucket that you're copying objects to uses the bucket owner enforced setting
/// for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets
/// that use this setting only accept
PUT requests that don't specify an
/// ACL or PUT requests that specify bucket owner full control ACLs, such
/// as the bucket-owner-full-control canned ACL or an equivalent form of
/// this ACL expressed in the XML format.
///
///
///
/// For more information, see
/// Controlling ownership of objects and disabling ACLs in the Amazon S3 User Guide.
///
///
///
/// 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.
///
/// - Checksums
-
///
/// When copying an object, if it has a checksum, that checksum will be copied to the
/// new object by default. When you copy the object over, you can optionally specify a
/// different checksum algorithm to use with the
x-amz-checksum-algorithm
/// header.
///
/// - Storage Class Options
-
///
/// You can use the
CopyObject action to change the storage class of an object
/// that is already stored in Amazon S3 by using the StorageClass parameter.
/// For more information, see Storage
/// Classes in the Amazon S3 User Guide.
///
///
///
/// If the source object's storage class is GLACIER or DEEP_ARCHIVE, or the object's storage
/// class is INTELLIGENT_TIERING and it's
/// S3 Intelligent-Tiering access tier is Archive Access or Deep Archive Access, you
/// must restore a copy of this object before you can use it as a source object for the
/// copy operation. For more information, see RestoreObject.
/// For more information, see Copying
/// Objects.
///
/// - Versioning
-
///
/// By default,
x-amz-copy-source 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 versionId
/// subresource.
///
///
///
/// If you enable versioning on the target bucket, Amazon S3 generates a unique version
/// ID for the object being copied. This version ID is different from the version ID of
/// the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id
/// response header in the response.
///
///
///
/// If you do not enable versioning or suspend it on the target bucket, the version ID
/// that Amazon S3 generates is always null.
///
///
///
/// The following operations are related to CopyObject:
///
///
///
/// A property of CopyObjectRequest used to execute the CopyObject service method.
/// A property of CopyObjectRequest used to execute the CopyObject service method.
/// A property of CopyObjectRequest used to execute the CopyObject service method.
/// 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 AccessPointName-AccountId.s3-accesspoint.Region.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 Using access points in the Amazon S3 User Guide. 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 AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. 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 What is S3 on Outposts? in the Amazon S3 User Guide.
/// A property of CopyObjectRequest used to execute the CopyObject service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CopyObject service method, as returned by S3.
/// REST API Reference for CopyObject Operation
public virtual Task CopyObjectAsync(string sourceBucket, string sourceKey, string sourceVersionId, string destinationBucket, string destinationKey, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var request = new CopyObjectRequest();
request.SourceBucket = sourceBucket;
request.SourceKey = sourceKey;
request.SourceVersionId = sourceVersionId;
request.DestinationBucket = destinationBucket;
request.DestinationKey = destinationKey;
return CopyObjectAsync(request, cancellationToken);
}
///
/// Creates a copy of an object that is already stored in Amazon S3.
///
///
///
/// You can store individual objects of up to 5 TB in Amazon S3. You create a copy of
/// your object up to 5 GB in size in a single atomic action using this API. However,
/// to copy an object greater than 5 GB, you must use the multipart upload Upload Part
/// - Copy (UploadPartCopy) API. For more information, see Copy
/// Object Using the REST Multipart Upload API.
///
///
///
/// All copy requests must be authenticated. Additionally, you must have read access
/// to the source object and write access to the destination bucket. For more information,
/// see REST
/// Authentication. Both the Region that you want to copy the object from and the
/// Region that you want to copy the object to must be enabled for your account.
///
///
///
/// A copy request might return an error when Amazon S3 receives the copy request or while
/// Amazon S3 is copying the files. If the error occurs before the copy action starts,
/// you receive a standard Amazon S3 error. If the error occurs during the copy operation,
/// the error response is embedded in the 200 OK response. This means that
/// a 200 OK response can contain either a success or an error. 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).
///
///
///
/// If the copy is successful, you receive a response with information about the copied
/// object.
///
///
///
/// 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.
///
///
///
/// 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 Amazon S3 pricing.
///
///
///
/// Amazon S3 transfer acceleration does not support cross-Region copies. If you request
/// a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad
/// Request error. For more information, see Transfer
/// Acceleration.
///
/// - Metadata
-
///
/// When copying an object, you can preserve all metadata (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 Using
/// ACLs.
///
///
///
/// To specify whether you want the object metadata copied from the source object or replaced
/// with metadata provided in the request, you can optionally add the
x-amz-metadata-directive
/// header. When you grant permissions, you can use the s3:x-amz-metadata-directive
/// condition key to enforce certain metadata behavior when objects are uploaded. For
/// more information, see Specifying
/// Conditions in a Policy in the Amazon S3 User Guide. For a complete list
/// of Amazon S3-specific condition keys, see Actions,
/// Resources, and Condition Keys for Amazon S3.
///
///
///
/// x-amz-website-redirect-location is unique to each object and must be
/// specified in the request headers to copy the value.
///
/// - x-amz-copy-source-if Headers
-
///
/// To only copy an object under certain conditions, such as whether the
Etag
/// matches or whether the object was modified before or after a specified date, use the
/// following request parameters:
///
/// -
///
///
x-amz-copy-source-if-match
///
/// -
///
///
x-amz-copy-source-if-none-match
///
/// -
///
///
x-amz-copy-source-if-unmodified-since
///
/// -
///
///
x-amz-copy-source-if-modified-since
///
///
///
/// If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since
/// headers are present in the request and evaluate as follows, Amazon S3 returns 200
/// OK and copies the data:
///
/// -
///
///
x-amz-copy-source-if-match condition evaluates to true
///
/// -
///
///
x-amz-copy-source-if-unmodified-since condition evaluates to false
///
///
///
/// If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since
/// headers are present in the request and evaluate as follows, Amazon S3 returns the
/// 412 Precondition Failed response code:
///
/// -
///
///
x-amz-copy-source-if-none-match condition evaluates to false
///
/// -
///
///
x-amz-copy-source-if-modified-since condition evaluates to true
///
///
///
/// All headers with the x-amz- prefix, including x-amz-copy-source,
/// must be signed.
///
/// - Server-side encryption
-
///
/// 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.
///
///
///
/// When you perform a
CopyObject 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 Using
/// Server-Side Encryption.
///
///
///
/// If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object. For
/// more information, see Amazon
/// S3 Bucket Keys in the Amazon S3 User Guide.
///
/// - Access Control List (ACL)-Specific Request Headers
-
///
/// When copying an object, you can optionally use headers to grant ACL-based permissions.
/// By default, all objects are private. Only the owner has full access control. When
/// adding a new object, you can grant permissions to individual Amazon Web Services accounts
/// or to predefined groups that are defined by Amazon S3. These permissions are then
/// added to the ACL on the object. For more information, see Access
/// Control List (ACL) Overview and Managing
/// ACLs Using the REST API.
///
///
///
/// If the bucket that you're copying objects to uses the bucket owner enforced setting
/// for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets
/// that use this setting only accept
PUT requests that don't specify an
/// ACL or PUT requests that specify bucket owner full control ACLs, such
/// as the bucket-owner-full-control canned ACL or an equivalent form of
/// this ACL expressed in the XML format.
///
///
///
/// For more information, see
/// Controlling ownership of objects and disabling ACLs in the Amazon S3 User Guide.
///
///
///
/// 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.
///
/// - Checksums
-
///
/// When copying an object, if it has a checksum, that checksum will be copied to the
/// new object by default. When you copy the object over, you can optionally specify a
/// different checksum algorithm to use with the
x-amz-checksum-algorithm
/// header.
///
/// - Storage Class Options
-
///
/// You can use the
CopyObject action to change the storage class of an object
/// that is already stored in Amazon S3 by using the StorageClass parameter.
/// For more information, see Storage
/// Classes in the Amazon S3 User Guide.
///
///
///
/// If the source object's storage class is GLACIER or DEEP_ARCHIVE, or the object's storage
/// class is INTELLIGENT_TIERING and it's
/// S3 Intelligent-Tiering access tier is Archive Access or Deep Archive Access, you
/// must restore a copy of this object before you can use it as a source object for the
/// copy operation. For more information, see RestoreObject.
/// For more information, see Copying
/// Objects.
///
/// - Versioning
-
///
/// By default,
x-amz-copy-source 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 versionId
/// subresource.
///
///
///
/// If you enable versioning on the target bucket, Amazon S3 generates a unique version
/// ID for the object being copied. This version ID is different from the version ID of
/// the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id
/// response header in the response.
///
///
///
/// If you do not enable versioning or suspend it on the target bucket, the version ID
/// that Amazon S3 generates is always null.
///
///
///
/// The following operations are related to CopyObject:
///
///
///
/// Container for the necessary parameters to execute the CopyObject service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CopyObject service method, as returned by S3.
/// REST API Reference for CopyObject Operation
public virtual Task CopyObjectAsync(CopyObjectRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = CopyObjectRequestMarshaller.Instance;
options.ResponseUnmarshaller = CopyObjectResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region CopyPart
///
/// Uploads a part by copying data from an existing object as data source. You specify
/// the data source by adding the request header x-amz-copy-source in your
/// request and a byte range by adding the request header x-amz-copy-source-range
/// in your request.
///
///
///
/// For information about maximum and minimum part sizes and other multipart upload specifications,
/// see Multipart
/// upload limits in the Amazon S3 User Guide.
///
///
///
/// Instead of using an existing object as part data, you might use the UploadPart
/// action and provide data in your request.
///
///
///
/// You must initiate a multipart upload before you can upload any part. In response to
/// your initiate request. Amazon S3 returns a unique identifier, the upload ID, that
/// you must include in your upload part request.
///
///
///
/// For more information about using the UploadPartCopy operation, see the
/// following:
///
/// -
///
/// For conceptual information about multipart uploads, see Uploading
/// Objects Using Multipart Upload in the Amazon S3 User Guide.
///
///
-
///
/// For information about permissions required to use the multipart upload API, see Multipart
/// Upload and Permissions in the Amazon S3 User Guide.
///
///
-
///
/// For information about copying objects using a single atomic action vs. a multipart
/// upload, see Operations
/// on Objects in the Amazon S3 User Guide.
///
///
-
///
/// For information about using server-side encryption with customer-provided encryption
/// keys with the
UploadPartCopy operation, see CopyObject
/// and UploadPart.
///
///
///
/// Note the following additional considerations about the request headers x-amz-copy-source-if-match,
/// x-amz-copy-source-if-none-match, x-amz-copy-source-if-unmodified-since,
/// and x-amz-copy-source-if-modified-since:
///
///
///
///
///
/// -
///
/// Consideration 1 - If both of the
x-amz-copy-source-if-match and
/// x-amz-copy-source-if-unmodified-since headers are present in the request
/// as follows:
///
///
///
/// x-amz-copy-source-if-match condition evaluates to true,
/// and;
///
///
///
/// x-amz-copy-source-if-unmodified-since condition evaluates to false;
///
///
///
/// Amazon S3 returns 200 OK and copies the data.
///
/// -
///
/// Consideration 2 - If both of the
x-amz-copy-source-if-none-match
/// and x-amz-copy-source-if-modified-since headers are present in the request
/// as follows:
///
///
///
/// x-amz-copy-source-if-none-match condition evaluates to false,
/// and;
///
///
///
/// x-amz-copy-source-if-modified-since condition evaluates to true;
///
///
///
/// Amazon S3 returns 412 Precondition Failed response code.
///
///
- Versioning
-
///
/// If your bucket has versioning enabled, you could have multiple versions of the same
/// object. By default,
x-amz-copy-source identifies the current version
/// of the object to copy. If the current version is a delete marker and you don't specify
/// a versionId in the x-amz-copy-source, Amazon S3 returns a 404 error,
/// because the object does not exist. If you specify versionId in the x-amz-copy-source
/// and the versionId is a delete marker, Amazon S3 returns an HTTP 400 error, because
/// you are not allowed to specify a delete marker as a version for the x-amz-copy-source.
///
///
///
///
/// You can optionally specify a specific version of the source object to copy by adding
/// the versionId subresource as shown in the following example:
///
///
///
/// x-amz-copy-source: /bucket/object?versionId=version id
///
/// - Special errors
-
-
-
///
/// Code: NoSuchUpload
///
///
-
///
/// Cause: The specified multipart upload does not exist. The upload ID might be invalid,
/// or the multipart upload might have been aborted or completed.
///
///
-
///
/// HTTP Status Code: 404 Not Found
///
///
-
-
///
/// Code: InvalidRequest
///
///
-
///
/// Cause: The specified copy source is not supported as a byte-range copy source.
///
///
///
-
///
/// HTTP Status Code: 400 Bad Request
///
///
///
/// The following operations are related to UploadPartCopy:
///
///
///
/// A property of CopyPartRequest used to execute the CopyPart service method.
/// A property of CopyPartRequest used to execute the CopyPart service method.
/// 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 AccessPointName-AccountId.s3-accesspoint.Region.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 Using access points in the Amazon S3 User Guide. 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 AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. 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 What is S3 on Outposts? in the Amazon S3 User Guide.
/// A property of CopyPartRequest used to execute the CopyPart service method.
/// Upload ID identifying the multipart upload whose part is being copied.
///
/// The response from the CopyPart service method, as returned by S3.
/// REST API Reference for CopyPart Operation
public virtual CopyPartResponse CopyPart(string sourceBucket, string sourceKey, string destinationBucket, string destinationKey, string uploadId)
{
var request = new CopyPartRequest();
request.SourceBucket = sourceBucket;
request.SourceKey = sourceKey;
request.DestinationBucket = destinationBucket;
request.DestinationKey = destinationKey;
request.UploadId = uploadId;
return CopyPart(request);
}
///
/// Uploads a part by copying data from an existing object as data source. You specify
/// the data source by adding the request header x-amz-copy-source in your
/// request and a byte range by adding the request header x-amz-copy-source-range
/// in your request.
///
///
///
/// For information about maximum and minimum part sizes and other multipart upload specifications,
/// see Multipart
/// upload limits in the Amazon S3 User Guide.
///
///
///
/// Instead of using an existing object as part data, you might use the UploadPart
/// action and provide data in your request.
///
///
///
/// You must initiate a multipart upload before you can upload any part. In response to
/// your initiate request. Amazon S3 returns a unique identifier, the upload ID, that
/// you must include in your upload part request.
///
///
///
/// For more information about using the UploadPartCopy operation, see the
/// following:
///
/// -
///
/// For conceptual information about multipart uploads, see Uploading
/// Objects Using Multipart Upload in the Amazon S3 User Guide.
///
///
-
///
/// For information about permissions required to use the multipart upload API, see Multipart
/// Upload and Permissions in the Amazon S3 User Guide.
///
///
-
///
/// For information about copying objects using a single atomic action vs. a multipart
/// upload, see Operations
/// on Objects in the Amazon S3 User Guide.
///
///
-
///
/// For information about using server-side encryption with customer-provided encryption
/// keys with the
UploadPartCopy operation, see CopyObject
/// and UploadPart.
///
///
///
/// Note the following additional considerations about the request headers x-amz-copy-source-if-match,
/// x-amz-copy-source-if-none-match, x-amz-copy-source-if-unmodified-since,
/// and x-amz-copy-source-if-modified-since:
///
///
///
///
///
/// -
///
/// Consideration 1 - If both of the
x-amz-copy-source-if-match and
/// x-amz-copy-source-if-unmodified-since headers are present in the request
/// as follows:
///
///
///
/// x-amz-copy-source-if-match condition evaluates to true,
/// and;
///
///
///
/// x-amz-copy-source-if-unmodified-since condition evaluates to false;
///
///
///
/// Amazon S3 returns 200 OK and copies the data.
///
/// -
///
/// Consideration 2 - If both of the
x-amz-copy-source-if-none-match
/// and x-amz-copy-source-if-modified-since headers are present in the request
/// as follows:
///
///
///
/// x-amz-copy-source-if-none-match condition evaluates to false,
/// and;
///
///
///
/// x-amz-copy-source-if-modified-since condition evaluates to true;
///
///
///
/// Amazon S3 returns 412 Precondition Failed response code.
///
///
- Versioning
-
///
/// If your bucket has versioning enabled, you could have multiple versions of the same
/// object. By default,
x-amz-copy-source identifies the current version
/// of the object to copy. If the current version is a delete marker and you don't specify
/// a versionId in the x-amz-copy-source, Amazon S3 returns a 404 error,
/// because the object does not exist. If you specify versionId in the x-amz-copy-source
/// and the versionId is a delete marker, Amazon S3 returns an HTTP 400 error, because
/// you are not allowed to specify a delete marker as a version for the x-amz-copy-source.
///
///
///
///
/// You can optionally specify a specific version of the source object to copy by adding
/// the versionId subresource as shown in the following example:
///
///
///
/// x-amz-copy-source: /bucket/object?versionId=version id
///
/// - Special errors
-
-
-
///
/// Code: NoSuchUpload
///
///
-
///
/// Cause: The specified multipart upload does not exist. The upload ID might be invalid,
/// or the multipart upload might have been aborted or completed.
///
///
-
///
/// HTTP Status Code: 404 Not Found
///
///
-
-
///
/// Code: InvalidRequest
///
///
-
///
/// Cause: The specified copy source is not supported as a byte-range copy source.
///
///
///
-
///
/// HTTP Status Code: 400 Bad Request
///
///
///
/// The following operations are related to UploadPartCopy:
///
///
///
/// A property of CopyPartRequest used to execute the CopyPart service method.
/// A property of CopyPartRequest used to execute the CopyPart service method.
/// A property of CopyPartRequest used to execute the CopyPart service method.
/// 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 AccessPointName-AccountId.s3-accesspoint.Region.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 Using access points in the Amazon S3 User Guide. 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 AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. 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 What is S3 on Outposts? in the Amazon S3 User Guide.
/// A property of CopyPartRequest used to execute the CopyPart service method.
/// Upload ID identifying the multipart upload whose part is being copied.
///
/// The response from the CopyPart service method, as returned by S3.
/// REST API Reference for CopyPart Operation
public virtual CopyPartResponse CopyPart(string sourceBucket, string sourceKey, string sourceVersionId, string destinationBucket, string destinationKey, string uploadId)
{
var request = new CopyPartRequest();
request.SourceBucket = sourceBucket;
request.SourceKey = sourceKey;
request.SourceVersionId = sourceVersionId;
request.DestinationBucket = destinationBucket;
request.DestinationKey = destinationKey;
request.UploadId = uploadId;
return CopyPart(request);
}
///
/// Uploads a part by copying data from an existing object as data source. You specify
/// the data source by adding the request header x-amz-copy-source in your
/// request and a byte range by adding the request header x-amz-copy-source-range
/// in your request.
///
///
///
/// For information about maximum and minimum part sizes and other multipart upload specifications,
/// see Multipart
/// upload limits in the Amazon S3 User Guide.
///
///
///
/// Instead of using an existing object as part data, you might use the UploadPart
/// action and provide data in your request.
///
///
///
/// You must initiate a multipart upload before you can upload any part. In response to
/// your initiate request. Amazon S3 returns a unique identifier, the upload ID, that
/// you must include in your upload part request.
///
///
///
/// For more information about using the UploadPartCopy operation, see the
/// following:
///
/// -
///
/// For conceptual information about multipart uploads, see Uploading
/// Objects Using Multipart Upload in the Amazon S3 User Guide.
///
///
-
///
/// For information about permissions required to use the multipart upload API, see Multipart
/// Upload and Permissions in the Amazon S3 User Guide.
///
///
-
///
/// For information about copying objects using a single atomic action vs. a multipart
/// upload, see Operations
/// on Objects in the Amazon S3 User Guide.
///
///
-
///
/// For information about using server-side encryption with customer-provided encryption
/// keys with the
UploadPartCopy operation, see CopyObject
/// and UploadPart.
///
///
///
/// Note the following additional considerations about the request headers x-amz-copy-source-if-match,
/// x-amz-copy-source-if-none-match, x-amz-copy-source-if-unmodified-since,
/// and x-amz-copy-source-if-modified-since:
///
///
///
///
///
/// -
///
/// Consideration 1 - If both of the
x-amz-copy-source-if-match and
/// x-amz-copy-source-if-unmodified-since headers are present in the request
/// as follows:
///
///
///
/// x-amz-copy-source-if-match condition evaluates to true,
/// and;
///
///
///
/// x-amz-copy-source-if-unmodified-since condition evaluates to false;
///
///
///
/// Amazon S3 returns 200 OK and copies the data.
///
/// -
///
/// Consideration 2 - If both of the
x-amz-copy-source-if-none-match
/// and x-amz-copy-source-if-modified-since headers are present in the request
/// as follows:
///
///
///
/// x-amz-copy-source-if-none-match condition evaluates to false,
/// and;
///
///
///
/// x-amz-copy-source-if-modified-since condition evaluates to true;
///
///
///
/// Amazon S3 returns 412 Precondition Failed response code.
///
///
- Versioning
-
///
/// If your bucket has versioning enabled, you could have multiple versions of the same
/// object. By default,
x-amz-copy-source identifies the current version
/// of the object to copy. If the current version is a delete marker and you don't specify
/// a versionId in the x-amz-copy-source, Amazon S3 returns a 404 error,
/// because the object does not exist. If you specify versionId in the x-amz-copy-source
/// and the versionId is a delete marker, Amazon S3 returns an HTTP 400 error, because
/// you are not allowed to specify a delete marker as a version for the x-amz-copy-source.
///
///
///
///
/// You can optionally specify a specific version of the source object to copy by adding
/// the versionId subresource as shown in the following example:
///
///
///
/// x-amz-copy-source: /bucket/object?versionId=version id
///
/// - Special errors
-
-
-
///
/// Code: NoSuchUpload
///
///
-
///
/// Cause: The specified multipart upload does not exist. The upload ID might be invalid,
/// or the multipart upload might have been aborted or completed.
///
///
-
///
/// HTTP Status Code: 404 Not Found
///
///
-
-
///
/// Code: InvalidRequest
///
///
-
///
/// Cause: The specified copy source is not supported as a byte-range copy source.
///
///
///
-
///
/// HTTP Status Code: 400 Bad Request
///
///
///
/// The following operations are related to UploadPartCopy:
///
///
///
/// Container for the necessary parameters to execute the CopyPart service method.
///
/// The response from the CopyPart service method, as returned by S3.
/// REST API Reference for CopyPart Operation
public virtual CopyPartResponse CopyPart(CopyPartRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = CopyPartRequestMarshaller.Instance;
options.ResponseUnmarshaller = CopyPartResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Uploads a part by copying data from an existing object as data source. You specify
/// the data source by adding the request header x-amz-copy-source in your
/// request and a byte range by adding the request header x-amz-copy-source-range
/// in your request.
///
///
///
/// For information about maximum and minimum part sizes and other multipart upload specifications,
/// see Multipart
/// upload limits in the Amazon S3 User Guide.
///
///
///
/// Instead of using an existing object as part data, you might use the UploadPart
/// action and provide data in your request.
///
///
///
/// You must initiate a multipart upload before you can upload any part. In response to
/// your initiate request. Amazon S3 returns a unique identifier, the upload ID, that
/// you must include in your upload part request.
///
///
///
/// For more information about using the UploadPartCopy operation, see the
/// following:
///
/// -
///
/// For conceptual information about multipart uploads, see Uploading
/// Objects Using Multipart Upload in the Amazon S3 User Guide.
///
///
-
///
/// For information about permissions required to use the multipart upload API, see Multipart
/// Upload and Permissions in the Amazon S3 User Guide.
///
///
-
///
/// For information about copying objects using a single atomic action vs. a multipart
/// upload, see Operations
/// on Objects in the Amazon S3 User Guide.
///
///
-
///
/// For information about using server-side encryption with customer-provided encryption
/// keys with the
UploadPartCopy operation, see CopyObject
/// and UploadPart.
///
///
///
/// Note the following additional considerations about the request headers x-amz-copy-source-if-match,
/// x-amz-copy-source-if-none-match, x-amz-copy-source-if-unmodified-since,
/// and x-amz-copy-source-if-modified-since:
///
///
///
///
///
/// -
///
/// Consideration 1 - If both of the
x-amz-copy-source-if-match and
/// x-amz-copy-source-if-unmodified-since headers are present in the request
/// as follows:
///
///
///
/// x-amz-copy-source-if-match condition evaluates to true,
/// and;
///
///
///
/// x-amz-copy-source-if-unmodified-since condition evaluates to false;
///
///
///
/// Amazon S3 returns 200 OK and copies the data.
///
/// -
///
/// Consideration 2 - If both of the
x-amz-copy-source-if-none-match
/// and x-amz-copy-source-if-modified-since headers are present in the request
/// as follows:
///
///
///
/// x-amz-copy-source-if-none-match condition evaluates to false,
/// and;
///
///
///
/// x-amz-copy-source-if-modified-since condition evaluates to true;
///
///
///
/// Amazon S3 returns 412 Precondition Failed response code.
///
///
- Versioning
-
///
/// If your bucket has versioning enabled, you could have multiple versions of the same
/// object. By default,
x-amz-copy-source identifies the current version
/// of the object to copy. If the current version is a delete marker and you don't specify
/// a versionId in the x-amz-copy-source, Amazon S3 returns a 404 error,
/// because the object does not exist. If you specify versionId in the x-amz-copy-source
/// and the versionId is a delete marker, Amazon S3 returns an HTTP 400 error, because
/// you are not allowed to specify a delete marker as a version for the x-amz-copy-source.
///
///
///
///
/// You can optionally specify a specific version of the source object to copy by adding
/// the versionId subresource as shown in the following example:
///
///
///
/// x-amz-copy-source: /bucket/object?versionId=version id
///
/// - Special errors
-
-
-
///
/// Code: NoSuchUpload
///
///
-
///
/// Cause: The specified multipart upload does not exist. The upload ID might be invalid,
/// or the multipart upload might have been aborted or completed.
///
///
-
///
/// HTTP Status Code: 404 Not Found
///
///
-
-
///
/// Code: InvalidRequest
///
///
-
///
/// Cause: The specified copy source is not supported as a byte-range copy source.
///
///
///
-
///
/// HTTP Status Code: 400 Bad Request
///
///
///
/// The following operations are related to UploadPartCopy:
///
///
///
/// A property of CopyPartRequest used to execute the CopyPart service method.
/// A property of CopyPartRequest used to execute the CopyPart service method.
/// 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 AccessPointName-AccountId.s3-accesspoint.Region.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 Using access points in the Amazon S3 User Guide. 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 AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. 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 What is S3 on Outposts? in the Amazon S3 User Guide.
/// A property of CopyPartRequest used to execute the CopyPart service method.
/// Upload ID identifying the multipart upload whose part is being copied.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CopyPart service method, as returned by S3.
/// REST API Reference for CopyPart Operation
public virtual Task CopyPartAsync(string sourceBucket, string sourceKey, string destinationBucket, string destinationKey, string uploadId, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var request = new CopyPartRequest();
request.SourceBucket = sourceBucket;
request.SourceKey = sourceKey;
request.DestinationBucket = destinationBucket;
request.DestinationKey = destinationKey;
request.UploadId = uploadId;
return CopyPartAsync(request, cancellationToken);
}
///
/// Uploads a part by copying data from an existing object as data source. You specify
/// the data source by adding the request header x-amz-copy-source in your
/// request and a byte range by adding the request header x-amz-copy-source-range
/// in your request.
///
///
///
/// For information about maximum and minimum part sizes and other multipart upload specifications,
/// see Multipart
/// upload limits in the Amazon S3 User Guide.
///
///
///
/// Instead of using an existing object as part data, you might use the UploadPart
/// action and provide data in your request.
///
///
///
/// You must initiate a multipart upload before you can upload any part. In response to
/// your initiate request. Amazon S3 returns a unique identifier, the upload ID, that
/// you must include in your upload part request.
///
///
///
/// For more information about using the UploadPartCopy operation, see the
/// following:
///
/// -
///
/// For conceptual information about multipart uploads, see Uploading
/// Objects Using Multipart Upload in the Amazon S3 User Guide.
///
///
-
///
/// For information about permissions required to use the multipart upload API, see Multipart
/// Upload and Permissions in the Amazon S3 User Guide.
///
///
-
///
/// For information about copying objects using a single atomic action vs. a multipart
/// upload, see Operations
/// on Objects in the Amazon S3 User Guide.
///
///
-
///
/// For information about using server-side encryption with customer-provided encryption
/// keys with the
UploadPartCopy operation, see CopyObject
/// and UploadPart.
///
///
///
/// Note the following additional considerations about the request headers x-amz-copy-source-if-match,
/// x-amz-copy-source-if-none-match, x-amz-copy-source-if-unmodified-since,
/// and x-amz-copy-source-if-modified-since:
///
///
///
///
///
/// -
///
/// Consideration 1 - If both of the
x-amz-copy-source-if-match and
/// x-amz-copy-source-if-unmodified-since headers are present in the request
/// as follows:
///
///
///
/// x-amz-copy-source-if-match condition evaluates to true,
/// and;
///
///
///
/// x-amz-copy-source-if-unmodified-since condition evaluates to false;
///
///
///
/// Amazon S3 returns 200 OK and copies the data.
///
/// -
///
/// Consideration 2 - If both of the
x-amz-copy-source-if-none-match
/// and x-amz-copy-source-if-modified-since headers are present in the request
/// as follows:
///
///
///
/// x-amz-copy-source-if-none-match condition evaluates to false,
/// and;
///
///
///
/// x-amz-copy-source-if-modified-since condition evaluates to true;
///
///
///
/// Amazon S3 returns 412 Precondition Failed response code.
///
///
- Versioning
-
///
/// If your bucket has versioning enabled, you could have multiple versions of the same
/// object. By default,
x-amz-copy-source identifies the current version
/// of the object to copy. If the current version is a delete marker and you don't specify
/// a versionId in the x-amz-copy-source, Amazon S3 returns a 404 error,
/// because the object does not exist. If you specify versionId in the x-amz-copy-source
/// and the versionId is a delete marker, Amazon S3 returns an HTTP 400 error, because
/// you are not allowed to specify a delete marker as a version for the x-amz-copy-source.
///
///
///
///
/// You can optionally specify a specific version of the source object to copy by adding
/// the versionId subresource as shown in the following example:
///
///
///
/// x-amz-copy-source: /bucket/object?versionId=version id
///
/// - Special errors
-
-
-
///
/// Code: NoSuchUpload
///
///
-
///
/// Cause: The specified multipart upload does not exist. The upload ID might be invalid,
/// or the multipart upload might have been aborted or completed.
///
///
-
///
/// HTTP Status Code: 404 Not Found
///
///
-
-
///
/// Code: InvalidRequest
///
///
-
///
/// Cause: The specified copy source is not supported as a byte-range copy source.
///
///
///
-
///
/// HTTP Status Code: 400 Bad Request
///
///
///
/// The following operations are related to UploadPartCopy:
///
///
///
/// A property of CopyPartRequest used to execute the CopyPart service method.
/// A property of CopyPartRequest used to execute the CopyPart service method.
/// A property of CopyPartRequest used to execute the CopyPart service method.
/// 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 AccessPointName-AccountId.s3-accesspoint.Region.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 Using access points in the Amazon S3 User Guide. 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 AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. 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 What is S3 on Outposts? in the Amazon S3 User Guide.
/// A property of CopyPartRequest used to execute the CopyPart service method.
/// Upload ID identifying the multipart upload whose part is being copied.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CopyPart service method, as returned by S3.
/// REST API Reference for CopyPart Operation
public virtual Task CopyPartAsync(string sourceBucket, string sourceKey, string sourceVersionId, string destinationBucket, string destinationKey, string uploadId, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var request = new CopyPartRequest();
request.SourceBucket = sourceBucket;
request.SourceKey = sourceKey;
request.SourceVersionId = sourceVersionId;
request.DestinationBucket = destinationBucket;
request.DestinationKey = destinationKey;
request.UploadId = uploadId;
return CopyPartAsync(request, cancellationToken);
}
///
/// Uploads a part by copying data from an existing object as data source. You specify
/// the data source by adding the request header x-amz-copy-source in your
/// request and a byte range by adding the request header x-amz-copy-source-range
/// in your request.
///
///
///
/// For information about maximum and minimum part sizes and other multipart upload specifications,
/// see Multipart
/// upload limits in the Amazon S3 User Guide.
///
///
///
/// Instead of using an existing object as part data, you might use the UploadPart
/// action and provide data in your request.
///
///
///
/// You must initiate a multipart upload before you can upload any part. In response to
/// your initiate request. Amazon S3 returns a unique identifier, the upload ID, that
/// you must include in your upload part request.
///
///
///
/// For more information about using the UploadPartCopy operation, see the
/// following:
///
/// -
///
/// For conceptual information about multipart uploads, see Uploading
/// Objects Using Multipart Upload in the Amazon S3 User Guide.
///
///
-
///
/// For information about permissions required to use the multipart upload API, see Multipart
/// Upload and Permissions in the Amazon S3 User Guide.
///
///
-
///
/// For information about copying objects using a single atomic action vs. a multipart
/// upload, see Operations
/// on Objects in the Amazon S3 User Guide.
///
///
-
///
/// For information about using server-side encryption with customer-provided encryption
/// keys with the
UploadPartCopy operation, see CopyObject
/// and UploadPart.
///
///
///
/// Note the following additional considerations about the request headers x-amz-copy-source-if-match,
/// x-amz-copy-source-if-none-match, x-amz-copy-source-if-unmodified-since,
/// and x-amz-copy-source-if-modified-since:
///
///
///
///
///
/// -
///
/// Consideration 1 - If both of the
x-amz-copy-source-if-match and
/// x-amz-copy-source-if-unmodified-since headers are present in the request
/// as follows:
///
///
///
/// x-amz-copy-source-if-match condition evaluates to true,
/// and;
///
///
///
/// x-amz-copy-source-if-unmodified-since condition evaluates to false;
///
///
///
/// Amazon S3 returns 200 OK and copies the data.
///
/// -
///
/// Consideration 2 - If both of the
x-amz-copy-source-if-none-match
/// and x-amz-copy-source-if-modified-since headers are present in the request
/// as follows:
///
///
///
/// x-amz-copy-source-if-none-match condition evaluates to false,
/// and;
///
///
///
/// x-amz-copy-source-if-modified-since condition evaluates to true;
///
///
///
/// Amazon S3 returns 412 Precondition Failed response code.
///
///
- Versioning
-
///
/// If your bucket has versioning enabled, you could have multiple versions of the same
/// object. By default,
x-amz-copy-source identifies the current version
/// of the object to copy. If the current version is a delete marker and you don't specify
/// a versionId in the x-amz-copy-source, Amazon S3 returns a 404 error,
/// because the object does not exist. If you specify versionId in the x-amz-copy-source
/// and the versionId is a delete marker, Amazon S3 returns an HTTP 400 error, because
/// you are not allowed to specify a delete marker as a version for the x-amz-copy-source.
///
///
///
///
/// You can optionally specify a specific version of the source object to copy by adding
/// the versionId subresource as shown in the following example:
///
///
///
/// x-amz-copy-source: /bucket/object?versionId=version id
///
/// - Special errors
-
-
-
///
/// Code: NoSuchUpload
///
///
-
///
/// Cause: The specified multipart upload does not exist. The upload ID might be invalid,
/// or the multipart upload might have been aborted or completed.
///
///
-
///
/// HTTP Status Code: 404 Not Found
///
///
-
-
///
/// Code: InvalidRequest
///
///
-
///
/// Cause: The specified copy source is not supported as a byte-range copy source.
///
///
///
-
///
/// HTTP Status Code: 400 Bad Request
///
///
///
/// The following operations are related to UploadPartCopy:
///
///
///
/// Container for the necessary parameters to execute the CopyPart service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CopyPart service method, as returned by S3.
/// REST API Reference for CopyPart Operation
public virtual Task CopyPartAsync(CopyPartRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = CopyPartRequestMarshaller.Instance;
options.ResponseUnmarshaller = CopyPartResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DeleteBucket
///
/// 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.
///
///
///
/// The following operations are related to DeleteBucket:
///
///
///
/// Specifies the bucket being deleted.
///
/// The response from the DeleteBucket service method, as returned by S3.
/// REST API Reference for DeleteBucket Operation
public virtual DeleteBucketResponse DeleteBucket(string bucketName)
{
var request = new DeleteBucketRequest();
request.BucketName = bucketName;
return DeleteBucket(request);
}
///
/// 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.
///
///
///
/// The following operations are related to DeleteBucket:
///
///
///
/// Container for the necessary parameters to execute the DeleteBucket service method.
///
/// The response from the DeleteBucket service method, as returned by S3.
/// REST API Reference for DeleteBucket Operation
public virtual DeleteBucketResponse DeleteBucket(DeleteBucketRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteBucketRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteBucketResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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.
///
///
///
/// The following operations are related to DeleteBucket:
///
///
///
/// Specifies the bucket being deleted.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteBucket service method, as returned by S3.
/// REST API Reference for DeleteBucket Operation
public virtual Task DeleteBucketAsync(string bucketName, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var request = new DeleteBucketRequest();
request.BucketName = bucketName;
return DeleteBucketAsync(request, cancellationToken);
}
///
/// 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.
///
///
///
/// The following operations are related to DeleteBucket:
///
///
///
/// Container for the necessary parameters to execute the DeleteBucket service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteBucket service method, as returned by S3.
/// REST API Reference for DeleteBucket Operation
public virtual Task DeleteBucketAsync(DeleteBucketRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteBucketRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteBucketResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DeleteBucketAnalyticsConfiguration
///
/// Deletes an analytics configuration for the bucket (specified by the analytics configuration
/// ID).
///
///
///
/// To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration
/// action. The bucket owner has this permission by default. The bucket owner can grant
/// this permission to others. For more information about permissions, see Permissions
/// Related to Bucket Subresource Operations and Managing
/// Access Permissions to Your Amazon S3 Resources.
///
///
///
/// For information about the Amazon S3 analytics feature, see Amazon
/// S3 Analytics – Storage Class Analysis.
///
///
///
/// The following operations are related to DeleteBucketAnalyticsConfiguration:
///
///
///
/// Container for the necessary parameters to execute the DeleteBucketAnalyticsConfiguration service method.
///
/// The response from the DeleteBucketAnalyticsConfiguration service method, as returned by S3.
/// REST API Reference for DeleteBucketAnalyticsConfiguration Operation
public virtual DeleteBucketAnalyticsConfigurationResponse DeleteBucketAnalyticsConfiguration(DeleteBucketAnalyticsConfigurationRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteBucketAnalyticsConfigurationRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteBucketAnalyticsConfigurationResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Deletes an analytics configuration for the bucket (specified by the analytics configuration
/// ID).
///
///
///
/// To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration
/// action. The bucket owner has this permission by default. The bucket owner can grant
/// this permission to others. For more information about permissions, see Permissions
/// Related to Bucket Subresource Operations and Managing
/// Access Permissions to Your Amazon S3 Resources.
///
///
///
/// For information about the Amazon S3 analytics feature, see Amazon
/// S3 Analytics – Storage Class Analysis.
///
///
///
/// The following operations are related to DeleteBucketAnalyticsConfiguration:
///
///
///
/// Container for the necessary parameters to execute the DeleteBucketAnalyticsConfiguration service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteBucketAnalyticsConfiguration service method, as returned by S3.
/// REST API Reference for DeleteBucketAnalyticsConfiguration Operation
public virtual Task DeleteBucketAnalyticsConfigurationAsync(DeleteBucketAnalyticsConfigurationRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteBucketAnalyticsConfigurationRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteBucketAnalyticsConfigurationResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DeleteBucketEncryption
///
/// 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 Amazon
/// S3 Bucket Default Encryption in the Amazon S3 User Guide.
///
///
///
/// To use this operation, you must have permissions to perform the s3:PutEncryptionConfiguration
/// action. The bucket owner has this permission by default. The bucket owner can grant
/// this permission to others. For more information about permissions, see Permissions
/// Related to Bucket Subresource Operations and Managing
/// Access Permissions to your Amazon S3 Resources in the Amazon S3 User Guide.
///
///
///
/// The following operations are related to DeleteBucketEncryption:
///
///
///
/// Container for the necessary parameters to execute the DeleteBucketEncryption service method.
///
/// The response from the DeleteBucketEncryption service method, as returned by S3.
/// REST API Reference for DeleteBucketEncryption Operation
public virtual DeleteBucketEncryptionResponse DeleteBucketEncryption(DeleteBucketEncryptionRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteBucketEncryptionRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteBucketEncryptionResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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 Amazon
/// S3 Bucket Default Encryption in the Amazon S3 User Guide.
///
///
///
/// To use this operation, you must have permissions to perform the s3:PutEncryptionConfiguration
/// action. The bucket owner has this permission by default. The bucket owner can grant
/// this permission to others. For more information about permissions, see Permissions
/// Related to Bucket Subresource Operations and Managing
/// Access Permissions to your Amazon S3 Resources in the Amazon S3 User Guide.
///
///
///
/// The following operations are related to DeleteBucketEncryption:
///
///
///
/// Container for the necessary parameters to execute the DeleteBucketEncryption service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteBucketEncryption service method, as returned by S3.
/// REST API Reference for DeleteBucketEncryption Operation
public virtual Task DeleteBucketEncryptionAsync(DeleteBucketEncryptionRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteBucketEncryptionRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteBucketEncryptionResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DeleteBucketIntelligentTieringConfiguration
///
/// Deletes the S3 Intelligent-Tiering configuration from the specified bucket.
///
///
///
/// The S3 Intelligent-Tiering storage class is designed to optimize storage costs by
/// automatically moving data to the most cost-effective storage access tier, without
/// performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic
/// cost savings in three low latency and high throughput access tiers. To get the lowest
/// storage cost on data that can be accessed in minutes to hours, you can choose to activate
/// additional archiving capabilities.
///
///
///
/// The S3 Intelligent-Tiering storage class is the ideal storage class for data with
/// unknown, changing, or unpredictable access patterns, independent of object size or
/// retention period. If the size of an object is less than 128 KB, it is not monitored
/// and not eligible for auto-tiering. Smaller objects can be stored, but they are always
/// charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.
///
///
///
/// For more information, see Storage
/// class for automatically optimizing frequently and infrequently accessed objects.
///
///
///
/// Operations related to DeleteBucketIntelligentTieringConfiguration include:
///
///
///
///
/// Container for the necessary parameters to execute the DeleteBucketIntelligentTieringConfiguration service method.
///
/// The response from the DeleteBucketIntelligentTieringConfiguration service method, as returned by S3.
/// REST API Reference for DeleteBucketIntelligentTieringConfiguration Operation
public virtual DeleteBucketIntelligentTieringConfigurationResponse DeleteBucketIntelligentTieringConfiguration(DeleteBucketIntelligentTieringConfigurationRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteBucketIntelligentTieringConfigurationRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteBucketIntelligentTieringConfigurationResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Deletes the S3 Intelligent-Tiering configuration from the specified bucket.
///
///
///
/// The S3 Intelligent-Tiering storage class is designed to optimize storage costs by
/// automatically moving data to the most cost-effective storage access tier, without
/// performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic
/// cost savings in three low latency and high throughput access tiers. To get the lowest
/// storage cost on data that can be accessed in minutes to hours, you can choose to activate
/// additional archiving capabilities.
///
///
///
/// The S3 Intelligent-Tiering storage class is the ideal storage class for data with
/// unknown, changing, or unpredictable access patterns, independent of object size or
/// retention period. If the size of an object is less than 128 KB, it is not monitored
/// and not eligible for auto-tiering. Smaller objects can be stored, but they are always
/// charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.
///
///
///
/// For more information, see Storage
/// class for automatically optimizing frequently and infrequently accessed objects.
///
///
///
/// Operations related to DeleteBucketIntelligentTieringConfiguration include:
///
///
///
///
/// Container for the necessary parameters to execute the DeleteBucketIntelligentTieringConfiguration service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteBucketIntelligentTieringConfiguration service method, as returned by S3.
/// REST API Reference for DeleteBucketIntelligentTieringConfiguration Operation
public virtual Task DeleteBucketIntelligentTieringConfigurationAsync(DeleteBucketIntelligentTieringConfigurationRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteBucketIntelligentTieringConfigurationRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteBucketIntelligentTieringConfigurationResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DeleteBucketInventoryConfiguration
///
/// Deletes an inventory configuration (identified by the inventory ID) from the bucket.
///
///
///
/// To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration
/// action. The bucket owner has this permission by default. The bucket owner can grant
/// this permission to others. For more information about permissions, see Permissions
/// Related to Bucket Subresource Operations and Managing
/// Access Permissions to Your Amazon S3 Resources.
///
///
///
/// For information about the Amazon S3 inventory feature, see Amazon
/// S3 Inventory.
///
///
///
/// Operations related to DeleteBucketInventoryConfiguration include:
///
///
///
/// Container for the necessary parameters to execute the DeleteBucketInventoryConfiguration service method.
///
/// The response from the DeleteBucketInventoryConfiguration service method, as returned by S3.
/// REST API Reference for DeleteBucketInventoryConfiguration Operation
public virtual DeleteBucketInventoryConfigurationResponse DeleteBucketInventoryConfiguration(DeleteBucketInventoryConfigurationRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteBucketInventoryConfigurationRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteBucketInventoryConfigurationResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Deletes an inventory configuration (identified by the inventory ID) from the bucket.
///
///
///
/// To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration
/// action. The bucket owner has this permission by default. The bucket owner can grant
/// this permission to others. For more information about permissions, see Permissions
/// Related to Bucket Subresource Operations and Managing
/// Access Permissions to Your Amazon S3 Resources.
///
///
///
/// For information about the Amazon S3 inventory feature, see Amazon
/// S3 Inventory.
///
///
///
/// Operations related to DeleteBucketInventoryConfiguration include:
///
///
///
/// Container for the necessary parameters to execute the DeleteBucketInventoryConfiguration service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteBucketInventoryConfiguration service method, as returned by S3.
/// REST API Reference for DeleteBucketInventoryConfiguration Operation
public virtual Task DeleteBucketInventoryConfigurationAsync(DeleteBucketInventoryConfigurationRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteBucketInventoryConfigurationRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteBucketInventoryConfigurationResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DeleteBucketMetricsConfiguration
///
/// Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified
/// by the metrics configuration ID) from the bucket. Note that this doesn't include the
/// daily storage metrics.
///
///
///
/// To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration
/// action. The bucket owner has this permission by default. The bucket owner can grant
/// this permission to others. For more information about permissions, see Permissions
/// Related to Bucket Subresource Operations and Managing
/// Access Permissions to Your Amazon S3 Resources.
///
///
///
/// For information about CloudWatch request metrics for Amazon S3, see Monitoring
/// Metrics with Amazon CloudWatch.
///
///
///
/// The following operations are related to DeleteBucketMetricsConfiguration:
///
///
///
/// Container for the necessary parameters to execute the DeleteBucketMetricsConfiguration service method.
///
/// The response from the DeleteBucketMetricsConfiguration service method, as returned by S3.
/// REST API Reference for DeleteBucketMetricsConfiguration Operation
public virtual DeleteBucketMetricsConfigurationResponse DeleteBucketMetricsConfiguration(DeleteBucketMetricsConfigurationRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteBucketMetricsConfigurationRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteBucketMetricsConfigurationResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified
/// by the metrics configuration ID) from the bucket. Note that this doesn't include the
/// daily storage metrics.
///
///
///
/// To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration
/// action. The bucket owner has this permission by default. The bucket owner can grant
/// this permission to others. For more information about permissions, see Permissions
/// Related to Bucket Subresource Operations and Managing
/// Access Permissions to Your Amazon S3 Resources.
///
///
///
/// For information about CloudWatch request metrics for Amazon S3, see Monitoring
/// Metrics with Amazon CloudWatch.
///
///
///
/// The following operations are related to DeleteBucketMetricsConfiguration:
///
///
///
/// Container for the necessary parameters to execute the DeleteBucketMetricsConfiguration service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteBucketMetricsConfiguration service method, as returned by S3.
/// REST API Reference for DeleteBucketMetricsConfiguration Operation
public virtual Task DeleteBucketMetricsConfigurationAsync(DeleteBucketMetricsConfigurationRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteBucketMetricsConfigurationRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteBucketMetricsConfigurationResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DeleteBucketOwnershipControls
///
/// Removes OwnershipControls for an Amazon S3 bucket. To use this operation,
/// you must have the s3:PutBucketOwnershipControls permission. For more
/// information about Amazon S3 permissions, see Specifying
/// Permissions in a Policy.
///
///
///
/// For information about Amazon S3 Object Ownership, see Using
/// Object Ownership.
///
///
///
/// The following operations are related to DeleteBucketOwnershipControls:
///
///
///
/// Container for the necessary parameters to execute the DeleteBucketOwnershipControls service method.
///
/// The response from the DeleteBucketOwnershipControls service method, as returned by S3.
/// REST API Reference for DeleteBucketOwnershipControls Operation
public virtual DeleteBucketOwnershipControlsResponse DeleteBucketOwnershipControls(DeleteBucketOwnershipControlsRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteBucketOwnershipControlsRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteBucketOwnershipControlsResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Removes OwnershipControls for an Amazon S3 bucket. To use this operation,
/// you must have the s3:PutBucketOwnershipControls permission. For more
/// information about Amazon S3 permissions, see Specifying
/// Permissions in a Policy.
///
///
///
/// For information about Amazon S3 Object Ownership, see Using
/// Object Ownership.
///
///
///
/// The following operations are related to DeleteBucketOwnershipControls:
///
///
///
/// Container for the necessary parameters to execute the DeleteBucketOwnershipControls service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteBucketOwnershipControls service method, as returned by S3.
/// REST API Reference for DeleteBucketOwnershipControls Operation
public virtual Task DeleteBucketOwnershipControlsAsync(DeleteBucketOwnershipControlsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteBucketOwnershipControlsRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteBucketOwnershipControlsResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DeleteBucketPolicy
///
/// This implementation of the DELETE action uses the policy subresource to delete the
/// policy of a specified bucket. If you are using an identity other than the root user
/// of the Amazon Web Services account that owns the bucket, the calling identity must
/// have the DeleteBucketPolicy permissions on the specified bucket and belong
/// to the bucket owner's account to use this operation.
///
///
///
/// If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a
/// 403 Access Denied error. If you have the correct permissions, but you're
/// not using an identity that belongs to the bucket owner's account, Amazon S3 returns
/// a 405 Method Not Allowed error.
///
///
///
/// 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 GetBucketPolicy, PutBucketPolicy, and DeleteBucketPolicy
/// 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.
///
///
///
/// For more information about bucket policies, see Using
/// Bucket Policies and UserPolicies.
///
///
///
/// The following operations are related to DeleteBucketPolicy
///
///
///
/// The bucket name.
///
/// The response from the DeleteBucketPolicy service method, as returned by S3.
/// REST API Reference for DeleteBucketPolicy Operation
public virtual DeleteBucketPolicyResponse DeleteBucketPolicy(string bucketName)
{
var request = new DeleteBucketPolicyRequest();
request.BucketName = bucketName;
return DeleteBucketPolicy(request);
}
///
/// This implementation of the DELETE action uses the policy subresource to delete the
/// policy of a specified bucket. If you are using an identity other than the root user
/// of the Amazon Web Services account that owns the bucket, the calling identity must
/// have the DeleteBucketPolicy permissions on the specified bucket and belong
/// to the bucket owner's account to use this operation.
///
///
///
/// If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a
/// 403 Access Denied error. If you have the correct permissions, but you're
/// not using an identity that belongs to the bucket owner's account, Amazon S3 returns
/// a 405 Method Not Allowed error.
///
///
///
/// 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 GetBucketPolicy, PutBucketPolicy, and DeleteBucketPolicy
/// 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.
///
///
///
/// For more information about bucket policies, see Using
/// Bucket Policies and UserPolicies.
///
///
///
/// The following operations are related to DeleteBucketPolicy
///
///
///
/// Container for the necessary parameters to execute the DeleteBucketPolicy service method.
///
/// The response from the DeleteBucketPolicy service method, as returned by S3.
/// REST API Reference for DeleteBucketPolicy Operation
public virtual DeleteBucketPolicyResponse DeleteBucketPolicy(DeleteBucketPolicyRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteBucketPolicyRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteBucketPolicyResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// This implementation of the DELETE action uses the policy subresource to delete the
/// policy of a specified bucket. If you are using an identity other than the root user
/// of the Amazon Web Services account that owns the bucket, the calling identity must
/// have the DeleteBucketPolicy permissions on the specified bucket and belong
/// to the bucket owner's account to use this operation.
///
///
///
/// If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a
/// 403 Access Denied error. If you have the correct permissions, but you're
/// not using an identity that belongs to the bucket owner's account, Amazon S3 returns
/// a 405 Method Not Allowed error.
///
///
///
/// 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 GetBucketPolicy, PutBucketPolicy, and DeleteBucketPolicy
/// 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.
///
///
///
/// For more information about bucket policies, see Using
/// Bucket Policies and UserPolicies.
///
///
///
/// The following operations are related to DeleteBucketPolicy
///
///
///
/// The bucket name.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteBucketPolicy service method, as returned by S3.
/// REST API Reference for DeleteBucketPolicy Operation
public virtual Task DeleteBucketPolicyAsync(string bucketName, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var request = new DeleteBucketPolicyRequest();
request.BucketName = bucketName;
return DeleteBucketPolicyAsync(request, cancellationToken);
}
///
/// This implementation of the DELETE action uses the policy subresource to delete the
/// policy of a specified bucket. If you are using an identity other than the root user
/// of the Amazon Web Services account that owns the bucket, the calling identity must
/// have the DeleteBucketPolicy permissions on the specified bucket and belong
/// to the bucket owner's account to use this operation.
///
///
///
/// If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a
/// 403 Access Denied error. If you have the correct permissions, but you're
/// not using an identity that belongs to the bucket owner's account, Amazon S3 returns
/// a 405 Method Not Allowed error.
///
///
///
/// 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 GetBucketPolicy, PutBucketPolicy, and DeleteBucketPolicy
/// 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.
///
///
///
/// For more information about bucket policies, see Using
/// Bucket Policies and UserPolicies.
///
///
///
/// The following operations are related to DeleteBucketPolicy
///
///
///
/// Container for the necessary parameters to execute the DeleteBucketPolicy service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteBucketPolicy service method, as returned by S3.
/// REST API Reference for DeleteBucketPolicy Operation
public virtual Task DeleteBucketPolicyAsync(DeleteBucketPolicyRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteBucketPolicyRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteBucketPolicyResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DeleteBucketReplication
///
/// Deletes the replication configuration from the bucket.
///
///
///
/// To use this operation, you must have permissions to perform the s3:PutReplicationConfiguration
/// action. The bucket owner has these permissions by default and can grant it to others.
/// For more information about permissions, see Permissions
/// Related to Bucket Subresource Operations and Managing
/// Access Permissions to Your Amazon S3 Resources.
///
///
///
/// It can take a while for the deletion of a replication configuration to fully propagate.
///
///
///
/// For information about replication configuration, see Replication
/// in the Amazon S3 User Guide.
///
///
///
/// The following operations are related to DeleteBucketReplication:
///
///
///
/// Container for the necessary parameters to execute the DeleteBucketReplication service method.
///
/// The response from the DeleteBucketReplication service method, as returned by S3.
/// REST API Reference for DeleteBucketReplication Operation
public virtual DeleteBucketReplicationResponse DeleteBucketReplication(DeleteBucketReplicationRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteBucketReplicationRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteBucketReplicationResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Deletes the replication configuration from the bucket.
///
///
///
/// To use this operation, you must have permissions to perform the s3:PutReplicationConfiguration
/// action. The bucket owner has these permissions by default and can grant it to others.
/// For more information about permissions, see Permissions
/// Related to Bucket Subresource Operations and Managing
/// Access Permissions to Your Amazon S3 Resources.
///
///
///
/// It can take a while for the deletion of a replication configuration to fully propagate.
///
///
///
/// For information about replication configuration, see Replication
/// in the Amazon S3 User Guide.
///
///
///
/// The following operations are related to DeleteBucketReplication:
///
///
///
/// Container for the necessary parameters to execute the DeleteBucketReplication service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteBucketReplication service method, as returned by S3.
/// REST API Reference for DeleteBucketReplication Operation
public virtual Task DeleteBucketReplicationAsync(DeleteBucketReplicationRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteBucketReplicationRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteBucketReplicationResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DeleteBucketTagging
///
/// Deletes the tags from the bucket.
///
///
///
/// To use this operation, you must have permission to perform the s3:PutBucketTagging
/// action. By default, the bucket owner has this permission and can grant this permission
/// to others.
///
///
///
/// The following operations are related to DeleteBucketTagging:
///
///
///
/// The bucket that has the tag set to be removed.
///
/// The response from the DeleteBucketTagging service method, as returned by S3.
/// REST API Reference for DeleteBucketTagging Operation
public virtual DeleteBucketTaggingResponse DeleteBucketTagging(string bucketName)
{
var request = new DeleteBucketTaggingRequest();
request.BucketName = bucketName;
return DeleteBucketTagging(request);
}
///
/// Deletes the tags from the bucket.
///
///
///
/// To use this operation, you must have permission to perform the s3:PutBucketTagging
/// action. By default, the bucket owner has this permission and can grant this permission
/// to others.
///
///
///
/// The following operations are related to DeleteBucketTagging:
///
///
///
/// Container for the necessary parameters to execute the DeleteBucketTagging service method.
///
/// The response from the DeleteBucketTagging service method, as returned by S3.
/// REST API Reference for DeleteBucketTagging Operation
public virtual DeleteBucketTaggingResponse DeleteBucketTagging(DeleteBucketTaggingRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteBucketTaggingRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteBucketTaggingResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Deletes the tags from the bucket.
///
///
///
/// To use this operation, you must have permission to perform the s3:PutBucketTagging
/// action. By default, the bucket owner has this permission and can grant this permission
/// to others.
///
///
///
/// The following operations are related to DeleteBucketTagging:
///
///
///
/// The bucket that has the tag set to be removed.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteBucketTagging service method, as returned by S3.
/// REST API Reference for DeleteBucketTagging Operation
public virtual Task DeleteBucketTaggingAsync(string bucketName, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var request = new DeleteBucketTaggingRequest();
request.BucketName = bucketName;
return DeleteBucketTaggingAsync(request, cancellationToken);
}
///
/// Deletes the tags from the bucket.
///
///
///
/// To use this operation, you must have permission to perform the s3:PutBucketTagging
/// action. By default, the bucket owner has this permission and can grant this permission
/// to others.
///
///
///
/// The following operations are related to DeleteBucketTagging:
///
///
///
/// Container for the necessary parameters to execute the DeleteBucketTagging service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteBucketTagging service method, as returned by S3.
/// REST API Reference for DeleteBucketTagging Operation
public virtual Task DeleteBucketTaggingAsync(DeleteBucketTaggingRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteBucketTaggingRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteBucketTaggingResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DeleteBucketWebsite
///
/// This action removes the website configuration for a bucket. Amazon S3 returns a 200
/// OK response upon successfully deleting a website configuration on the specified
/// bucket. You will get a 200 OK response if the website configuration you
/// are trying to delete does not exist on the bucket. Amazon S3 returns a 404
/// response if the bucket specified in the request does not exist.
///
///
///
/// This DELETE action requires the S3:DeleteBucketWebsite permission. By
/// default, only the bucket owner can delete the website configuration attached to a
/// bucket. However, bucket owners can grant other users permission to delete the website
/// configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite
/// permission.
///
///
///
/// For more information about hosting websites, see Hosting
/// Websites on Amazon S3.
///
///
///
/// The following operations are related to DeleteBucketWebsite:
///
///
///
/// The bucket name for which you want to remove the website configuration.
///
/// The response from the DeleteBucketWebsite service method, as returned by S3.
/// REST API Reference for DeleteBucketWebsite Operation
public virtual DeleteBucketWebsiteResponse DeleteBucketWebsite(string bucketName)
{
var request = new DeleteBucketWebsiteRequest();
request.BucketName = bucketName;
return DeleteBucketWebsite(request);
}
///
/// This action removes the website configuration for a bucket. Amazon S3 returns a 200
/// OK response upon successfully deleting a website configuration on the specified
/// bucket. You will get a 200 OK response if the website configuration you
/// are trying to delete does not exist on the bucket. Amazon S3 returns a 404
/// response if the bucket specified in the request does not exist.
///
///
///
/// This DELETE action requires the S3:DeleteBucketWebsite permission. By
/// default, only the bucket owner can delete the website configuration attached to a
/// bucket. However, bucket owners can grant other users permission to delete the website
/// configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite
/// permission.
///
///
///
/// For more information about hosting websites, see Hosting
/// Websites on Amazon S3.
///
///
///
/// The following operations are related to DeleteBucketWebsite:
///
///
///
/// Container for the necessary parameters to execute the DeleteBucketWebsite service method.
///
/// The response from the DeleteBucketWebsite service method, as returned by S3.
/// REST API Reference for DeleteBucketWebsite Operation
public virtual DeleteBucketWebsiteResponse DeleteBucketWebsite(DeleteBucketWebsiteRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteBucketWebsiteRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteBucketWebsiteResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// This action removes the website configuration for a bucket. Amazon S3 returns a 200
/// OK response upon successfully deleting a website configuration on the specified
/// bucket. You will get a 200 OK response if the website configuration you
/// are trying to delete does not exist on the bucket. Amazon S3 returns a 404
/// response if the bucket specified in the request does not exist.
///
///
///
/// This DELETE action requires the S3:DeleteBucketWebsite permission. By
/// default, only the bucket owner can delete the website configuration attached to a
/// bucket. However, bucket owners can grant other users permission to delete the website
/// configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite
/// permission.
///
///
///
/// For more information about hosting websites, see Hosting
/// Websites on Amazon S3.
///
///
///
/// The following operations are related to DeleteBucketWebsite:
///
///
///
/// The bucket name for which you want to remove the website configuration.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteBucketWebsite service method, as returned by S3.
/// REST API Reference for DeleteBucketWebsite Operation
public virtual Task DeleteBucketWebsiteAsync(string bucketName, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var request = new DeleteBucketWebsiteRequest();
request.BucketName = bucketName;
return DeleteBucketWebsiteAsync(request, cancellationToken);
}
///
/// This action removes the website configuration for a bucket. Amazon S3 returns a 200
/// OK response upon successfully deleting a website configuration on the specified
/// bucket. You will get a 200 OK response if the website configuration you
/// are trying to delete does not exist on the bucket. Amazon S3 returns a 404
/// response if the bucket specified in the request does not exist.
///
///
///
/// This DELETE action requires the S3:DeleteBucketWebsite permission. By
/// default, only the bucket owner can delete the website configuration attached to a
/// bucket. However, bucket owners can grant other users permission to delete the website
/// configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite
/// permission.
///
///
///
/// For more information about hosting websites, see Hosting
/// Websites on Amazon S3.
///
///
///
/// The following operations are related to DeleteBucketWebsite:
///
///
///
/// Container for the necessary parameters to execute the DeleteBucketWebsite service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteBucketWebsite service method, as returned by S3.
/// REST API Reference for DeleteBucketWebsite Operation
public virtual Task DeleteBucketWebsiteAsync(DeleteBucketWebsiteRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteBucketWebsiteRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteBucketWebsiteResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DeleteCORSConfiguration
///
/// Deletes the cors configuration information set for the bucket.
///
///
///
/// To use this operation, you must have permission to perform the s3:PutBucketCORS
/// action. The bucket owner has this permission by default and can grant this permission
/// to others.
///
///
///
/// For information about cors, see Enabling
/// Cross-Origin Resource Sharing in the Amazon S3 User Guide.
///
///
///
/// Related Resources
///
///
///
/// Specifies the bucket whose cors configuration is being deleted.
///
/// The response from the DeleteCORSConfiguration service method, as returned by S3.
/// REST API Reference for DeleteCORSConfiguration Operation
public virtual DeleteCORSConfigurationResponse DeleteCORSConfiguration(string bucketName)
{
var request = new DeleteCORSConfigurationRequest();
request.BucketName = bucketName;
return DeleteCORSConfiguration(request);
}
///
/// Deletes the cors configuration information set for the bucket.
///
///
///
/// To use this operation, you must have permission to perform the s3:PutBucketCORS
/// action. The bucket owner has this permission by default and can grant this permission
/// to others.
///
///
///
/// For information about cors, see Enabling
/// Cross-Origin Resource Sharing in the Amazon S3 User Guide.
///
///
///
/// Related Resources
///
///
///
/// Container for the necessary parameters to execute the DeleteCORSConfiguration service method.
///
/// The response from the DeleteCORSConfiguration service method, as returned by S3.
/// REST API Reference for DeleteCORSConfiguration Operation
public virtual DeleteCORSConfigurationResponse DeleteCORSConfiguration(DeleteCORSConfigurationRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteCORSConfigurationRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteCORSConfigurationResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Deletes the cors configuration information set for the bucket.
///
///
///
/// To use this operation, you must have permission to perform the s3:PutBucketCORS
/// action. The bucket owner has this permission by default and can grant this permission
/// to others.
///
///
///
/// For information about cors, see Enabling
/// Cross-Origin Resource Sharing in the Amazon S3 User Guide.
///
///
///
/// Related Resources
///
///
///
/// Specifies the bucket whose cors configuration is being deleted.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteCORSConfiguration service method, as returned by S3.
/// REST API Reference for DeleteCORSConfiguration Operation
public virtual Task DeleteCORSConfigurationAsync(string bucketName, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var request = new DeleteCORSConfigurationRequest();
request.BucketName = bucketName;
return DeleteCORSConfigurationAsync(request, cancellationToken);
}
///
/// Deletes the cors configuration information set for the bucket.
///
///
///
/// To use this operation, you must have permission to perform the s3:PutBucketCORS
/// action. The bucket owner has this permission by default and can grant this permission
/// to others.
///
///
///
/// For information about cors, see Enabling
/// Cross-Origin Resource Sharing in the Amazon S3 User Guide.
///
///
///
/// Related Resources
///
///
///
/// Container for the necessary parameters to execute the DeleteCORSConfiguration service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteCORSConfiguration service method, as returned by S3.
/// REST API Reference for DeleteCORSConfiguration Operation
public virtual Task DeleteCORSConfigurationAsync(DeleteCORSConfigurationRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteCORSConfigurationRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteCORSConfigurationResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DeleteLifecycleConfiguration
///
/// Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all
/// the lifecycle configuration rules in the lifecycle subresource associated with the
/// bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any
/// objects on the basis of rules contained in the deleted lifecycle configuration.
///
///
///
/// To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration
/// action. By default, the bucket owner has this permission and the bucket owner can
/// grant this permission to others.
///
///
///
/// There is usually some time lag before lifecycle configuration deletion is fully propagated
/// to all the Amazon S3 systems.
///
///
///
/// For more information about the object expiration, see Elements
/// to Describe Lifecycle Actions.
///
///
///
/// Related actions include:
///
///
///
/// The bucket name of the lifecycle to delete.
///
/// The response from the DeleteLifecycleConfiguration service method, as returned by S3.
/// REST API Reference for DeleteLifecycleConfiguration Operation
public virtual DeleteLifecycleConfigurationResponse DeleteLifecycleConfiguration(string bucketName)
{
var request = new DeleteLifecycleConfigurationRequest();
request.BucketName = bucketName;
return DeleteLifecycleConfiguration(request);
}
///
/// Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all
/// the lifecycle configuration rules in the lifecycle subresource associated with the
/// bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any
/// objects on the basis of rules contained in the deleted lifecycle configuration.
///
///
///
/// To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration
/// action. By default, the bucket owner has this permission and the bucket owner can
/// grant this permission to others.
///
///
///
/// There is usually some time lag before lifecycle configuration deletion is fully propagated
/// to all the Amazon S3 systems.
///
///
///
/// For more information about the object expiration, see Elements
/// to Describe Lifecycle Actions.
///
///
///
/// Related actions include:
///
///
///
/// Container for the necessary parameters to execute the DeleteLifecycleConfiguration service method.
///
/// The response from the DeleteLifecycleConfiguration service method, as returned by S3.
/// REST API Reference for DeleteLifecycleConfiguration Operation
public virtual DeleteLifecycleConfigurationResponse DeleteLifecycleConfiguration(DeleteLifecycleConfigurationRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteLifecycleConfigurationRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteLifecycleConfigurationResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all
/// the lifecycle configuration rules in the lifecycle subresource associated with the
/// bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any
/// objects on the basis of rules contained in the deleted lifecycle configuration.
///
///
///
/// To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration
/// action. By default, the bucket owner has this permission and the bucket owner can
/// grant this permission to others.
///
///
///
/// There is usually some time lag before lifecycle configuration deletion is fully propagated
/// to all the Amazon S3 systems.
///
///
///
/// For more information about the object expiration, see Elements
/// to Describe Lifecycle Actions.
///
///
///
/// Related actions include:
///
///
///
/// The bucket name of the lifecycle to delete.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteLifecycleConfiguration service method, as returned by S3.
/// REST API Reference for DeleteLifecycleConfiguration Operation
public virtual Task DeleteLifecycleConfigurationAsync(string bucketName, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var request = new DeleteLifecycleConfigurationRequest();
request.BucketName = bucketName;
return DeleteLifecycleConfigurationAsync(request, cancellationToken);
}
///
/// Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all
/// the lifecycle configuration rules in the lifecycle subresource associated with the
/// bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any
/// objects on the basis of rules contained in the deleted lifecycle configuration.
///
///
///
/// To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration
/// action. By default, the bucket owner has this permission and the bucket owner can
/// grant this permission to others.
///
///
///
/// There is usually some time lag before lifecycle configuration deletion is fully propagated
/// to all the Amazon S3 systems.
///
///
///
/// For more information about the object expiration, see Elements
/// to Describe Lifecycle Actions.
///
///
///
/// Related actions include:
///
///
///
/// Container for the necessary parameters to execute the DeleteLifecycleConfiguration service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteLifecycleConfiguration service method, as returned by S3.
/// REST API Reference for DeleteLifecycleConfiguration Operation
public virtual Task DeleteLifecycleConfigurationAsync(DeleteLifecycleConfigurationRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteLifecycleConfigurationRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteLifecycleConfigurationResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DeleteObject
///
/// Removes the null version (if there is one) of an object and inserts a delete marker,
/// which becomes the latest version of the object. If there isn't a null version, Amazon
/// S3 does not remove any objects but will still respond that the command was successful.
///
///
///
/// To remove a specific version, you must use the version Id subresource. Using this
/// subresource permanently deletes the version. If the object deleted is a delete marker,
/// Amazon S3 sets the response header, x-amz-delete-marker, to true.
///
///
///
/// If the object you want to delete is in a bucket where the bucket versioning configuration
/// is MFA Delete enabled, you must include the x-amz-mfa request header
/// in the DELETE versionId request. Requests that include x-amz-mfa
/// must use HTTPS.
///
///
///
/// For more information about MFA Delete, see Using
/// MFA Delete. To see sample requests that use versioning, see Sample
/// Request.
///
///
///
/// You can delete objects by explicitly calling DELETE Object or configure its lifecycle
/// (PutBucketLifecycle)
/// to enable Amazon S3 to remove them for you. If you want to block users or accounts
/// from removing or deleting objects from your bucket, you must deny them the s3:DeleteObject,
/// s3:DeleteObjectVersion, and s3:PutLifeCycleConfiguration
/// actions.
///
///
///
/// The following action is related to DeleteObject:
///
///
///
/// 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 AccessPointName-AccountId.s3-accesspoint.Region.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 Using access points in the Amazon S3 User Guide. 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 AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. 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 What is S3 on Outposts? in the Amazon S3 User Guide.
/// Key name of the object to delete.
///
/// The response from the DeleteObject service method, as returned by S3.
/// REST API Reference for DeleteObject Operation
public virtual DeleteObjectResponse DeleteObject(string bucketName, string key)
{
var request = new DeleteObjectRequest();
request.BucketName = bucketName;
request.Key = key;
return DeleteObject(request);
}
///
/// Removes the null version (if there is one) of an object and inserts a delete marker,
/// which becomes the latest version of the object. If there isn't a null version, Amazon
/// S3 does not remove any objects but will still respond that the command was successful.
///
///
///
/// To remove a specific version, you must use the version Id subresource. Using this
/// subresource permanently deletes the version. If the object deleted is a delete marker,
/// Amazon S3 sets the response header, x-amz-delete-marker, to true.
///
///
///
/// If the object you want to delete is in a bucket where the bucket versioning configuration
/// is MFA Delete enabled, you must include the x-amz-mfa request header
/// in the DELETE versionId request. Requests that include x-amz-mfa
/// must use HTTPS.
///
///
///
/// For more information about MFA Delete, see Using
/// MFA Delete. To see sample requests that use versioning, see Sample
/// Request.
///
///
///
/// You can delete objects by explicitly calling DELETE Object or configure its lifecycle
/// (PutBucketLifecycle)
/// to enable Amazon S3 to remove them for you. If you want to block users or accounts
/// from removing or deleting objects from your bucket, you must deny them the s3:DeleteObject,
/// s3:DeleteObjectVersion, and s3:PutLifeCycleConfiguration
/// actions.
///
///
///
/// The following action is related to DeleteObject:
///
///
///
/// 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 AccessPointName-AccountId.s3-accesspoint.Region.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 Using access points in the Amazon S3 User Guide. 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 AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. 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 What is S3 on Outposts? in the Amazon S3 User Guide.
/// Key name of the object to delete.
/// VersionId used to reference a specific version of the object.
///
/// The response from the DeleteObject service method, as returned by S3.
/// REST API Reference for DeleteObject Operation
public virtual DeleteObjectResponse DeleteObject(string bucketName, string key, string versionId)
{
var request = new DeleteObjectRequest();
request.BucketName = bucketName;
request.Key = key;
request.VersionId = versionId;
return DeleteObject(request);
}
///
/// Removes the null version (if there is one) of an object and inserts a delete marker,
/// which becomes the latest version of the object. If there isn't a null version, Amazon
/// S3 does not remove any objects but will still respond that the command was successful.
///
///
///
/// To remove a specific version, you must use the version Id subresource. Using this
/// subresource permanently deletes the version. If the object deleted is a delete marker,
/// Amazon S3 sets the response header, x-amz-delete-marker, to true.
///
///
///
/// If the object you want to delete is in a bucket where the bucket versioning configuration
/// is MFA Delete enabled, you must include the x-amz-mfa request header
/// in the DELETE versionId request. Requests that include x-amz-mfa
/// must use HTTPS.
///
///
///
/// For more information about MFA Delete, see Using
/// MFA Delete. To see sample requests that use versioning, see Sample
/// Request.
///
///
///
/// You can delete objects by explicitly calling DELETE Object or configure its lifecycle
/// (PutBucketLifecycle)
/// to enable Amazon S3 to remove them for you. If you want to block users or accounts
/// from removing or deleting objects from your bucket, you must deny them the s3:DeleteObject,
/// s3:DeleteObjectVersion, and s3:PutLifeCycleConfiguration
/// actions.
///
///
///
/// The following action is related to DeleteObject:
///
///
///
/// Container for the necessary parameters to execute the DeleteObject service method.
///
/// The response from the DeleteObject service method, as returned by S3.
/// REST API Reference for DeleteObject Operation
public virtual DeleteObjectResponse DeleteObject(DeleteObjectRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteObjectRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteObjectResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Removes the null version (if there is one) of an object and inserts a delete marker,
/// which becomes the latest version of the object. If there isn't a null version, Amazon
/// S3 does not remove any objects but will still respond that the command was successful.
///
///
///
/// To remove a specific version, you must use the version Id subresource. Using this
/// subresource permanently deletes the version. If the object deleted is a delete marker,
/// Amazon S3 sets the response header, x-amz-delete-marker, to true.
///
///
///
/// If the object you want to delete is in a bucket where the bucket versioning configuration
/// is MFA Delete enabled, you must include the x-amz-mfa request header
/// in the DELETE versionId request. Requests that include x-amz-mfa
/// must use HTTPS.
///
///
///
/// For more information about MFA Delete, see Using
/// MFA Delete. To see sample requests that use versioning, see Sample
/// Request.
///
///
///
/// You can delete objects by explicitly calling DELETE Object or configure its lifecycle
/// (PutBucketLifecycle)
/// to enable Amazon S3 to remove them for you. If you want to block users or accounts
/// from removing or deleting objects from your bucket, you must deny them the s3:DeleteObject,
/// s3:DeleteObjectVersion, and s3:PutLifeCycleConfiguration
/// actions.
///
///
///
/// The following action is related to DeleteObject:
///
///
///
/// 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 AccessPointName-AccountId.s3-accesspoint.Region.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 Using access points in the Amazon S3 User Guide. 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 AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. 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 What is S3 on Outposts? in the Amazon S3 User Guide.
/// Key name of the object to delete.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteObject service method, as returned by S3.
/// REST API Reference for DeleteObject Operation
public virtual Task DeleteObjectAsync(string bucketName, string key, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var request = new DeleteObjectRequest();
request.BucketName = bucketName;
request.Key = key;
return DeleteObjectAsync(request, cancellationToken);
}
///
/// Removes the null version (if there is one) of an object and inserts a delete marker,
/// which becomes the latest version of the object. If there isn't a null version, Amazon
/// S3 does not remove any objects but will still respond that the command was successful.
///
///
///
/// To remove a specific version, you must use the version Id subresource. Using this
/// subresource permanently deletes the version. If the object deleted is a delete marker,
/// Amazon S3 sets the response header, x-amz-delete-marker, to true.
///
///
///
/// If the object you want to delete is in a bucket where the bucket versioning configuration
/// is MFA Delete enabled, you must include the x-amz-mfa request header
/// in the DELETE versionId request. Requests that include x-amz-mfa
/// must use HTTPS.
///
///
///
/// For more information about MFA Delete, see Using
/// MFA Delete. To see sample requests that use versioning, see Sample
/// Request.
///
///
///
/// You can delete objects by explicitly calling DELETE Object or configure its lifecycle
/// (PutBucketLifecycle)
/// to enable Amazon S3 to remove them for you. If you want to block users or accounts
/// from removing or deleting objects from your bucket, you must deny them the s3:DeleteObject,
/// s3:DeleteObjectVersion, and s3:PutLifeCycleConfiguration
/// actions.
///
///
///
/// The following action is related to DeleteObject:
///
///
///
/// 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 AccessPointName-AccountId.s3-accesspoint.Region.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 Using access points in the Amazon S3 User Guide. 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 AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. 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 What is S3 on Outposts? in the Amazon S3 User Guide.
/// Key name of the object to delete.
/// VersionId used to reference a specific version of the object.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteObject service method, as returned by S3.
/// REST API Reference for DeleteObject Operation
public virtual Task DeleteObjectAsync(string bucketName, string key, string versionId, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var request = new DeleteObjectRequest();
request.BucketName = bucketName;
request.Key = key;
request.VersionId = versionId;
return DeleteObjectAsync(request, cancellationToken);
}
///
/// Removes the null version (if there is one) of an object and inserts a delete marker,
/// which becomes the latest version of the object. If there isn't a null version, Amazon
/// S3 does not remove any objects but will still respond that the command was successful.
///
///
///
/// To remove a specific version, you must use the version Id subresource. Using this
/// subresource permanently deletes the version. If the object deleted is a delete marker,
/// Amazon S3 sets the response header, x-amz-delete-marker, to true.
///
///
///
/// If the object you want to delete is in a bucket where the bucket versioning configuration
/// is MFA Delete enabled, you must include the x-amz-mfa request header
/// in the DELETE versionId request. Requests that include x-amz-mfa
/// must use HTTPS.
///
///
///
/// For more information about MFA Delete, see Using
/// MFA Delete. To see sample requests that use versioning, see Sample
/// Request.
///
///
///
/// You can delete objects by explicitly calling DELETE Object or configure its lifecycle
/// (PutBucketLifecycle)
/// to enable Amazon S3 to remove them for you. If you want to block users or accounts
/// from removing or deleting objects from your bucket, you must deny them the s3:DeleteObject,
/// s3:DeleteObjectVersion, and s3:PutLifeCycleConfiguration
/// actions.
///
///
///
/// The following action is related to DeleteObject:
///
///
///
/// Container for the necessary parameters to execute the DeleteObject service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteObject service method, as returned by S3.
/// REST API Reference for DeleteObject Operation
public virtual Task DeleteObjectAsync(DeleteObjectRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteObjectRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteObjectResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DeleteObjects
///
/// This action enables you to delete multiple objects from a bucket using a single HTTP
/// request. If you know the object keys that you want to delete, then this action provides
/// a suitable alternative to sending individual delete requests, reducing per-request
/// overhead.
///
///
///
/// The request contains a list of up to 1000 keys that you want to delete. In the XML,
/// you provide the object key names, and optionally, version IDs if you want to delete
/// a specific version of the object from a versioning-enabled bucket. For each key, Amazon
/// S3 performs a delete action and returns the result of that delete, success, or failure,
/// in the response. Note that if the object specified in the request is not found, Amazon
/// S3 returns the result as deleted.
///
///
///
/// The action supports two modes for the response: verbose and quiet. By default, the
/// action uses verbose mode in which the response includes the result of deletion of
/// each key in your request. In quiet mode the response includes only keys where the
/// delete action encountered an error. For a successful deletion, the action does not
/// return any information about the delete in the response body.
///
///
///
/// When performing this action on an MFA Delete enabled bucket, that attempts to delete
/// any versioned objects, you must include an MFA token. If you do not provide one, the
/// entire request will fail, even if there are non-versioned objects you are trying to
/// delete. If you provide an invalid token, whether there are versioned keys in the request
/// or not, the entire Multi-Object Delete request will fail. For information about MFA
/// Delete, see
/// MFA Delete.
///
///
///
/// Finally, the Content-MD5 header is required for all Multi-Object Delete requests.
/// Amazon S3 uses the header value to ensure that your request body has not been altered
/// in transit.
///
///
///
/// The following operations are related to DeleteObjects:
///
///
///
/// Container for the necessary parameters to execute the DeleteObjects service method.
///
/// The response from the DeleteObjects service method, as returned by S3.
/// REST API Reference for DeleteObjects Operation
public virtual DeleteObjectsResponse DeleteObjects(DeleteObjectsRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteObjectsRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteObjectsResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// This action enables you to delete multiple objects from a bucket using a single HTTP
/// request. If you know the object keys that you want to delete, then this action provides
/// a suitable alternative to sending individual delete requests, reducing per-request
/// overhead.
///
///
///
/// The request contains a list of up to 1000 keys that you want to delete. In the XML,
/// you provide the object key names, and optionally, version IDs if you want to delete
/// a specific version of the object from a versioning-enabled bucket. For each key, Amazon
/// S3 performs a delete action and returns the result of that delete, success, or failure,
/// in the response. Note that if the object specified in the request is not found, Amazon
/// S3 returns the result as deleted.
///
///
///
/// The action supports two modes for the response: verbose and quiet. By default, the
/// action uses verbose mode in which the response includes the result of deletion of
/// each key in your request. In quiet mode the response includes only keys where the
/// delete action encountered an error. For a successful deletion, the action does not
/// return any information about the delete in the response body.
///
///
///
/// When performing this action on an MFA Delete enabled bucket, that attempts to delete
/// any versioned objects, you must include an MFA token. If you do not provide one, the
/// entire request will fail, even if there are non-versioned objects you are trying to
/// delete. If you provide an invalid token, whether there are versioned keys in the request
/// or not, the entire Multi-Object Delete request will fail. For information about MFA
/// Delete, see
/// MFA Delete.
///
///
///
/// Finally, the Content-MD5 header is required for all Multi-Object Delete requests.
/// Amazon S3 uses the header value to ensure that your request body has not been altered
/// in transit.
///
///
///
/// The following operations are related to DeleteObjects:
///
///
///
/// Container for the necessary parameters to execute the DeleteObjects service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteObjects service method, as returned by S3.
/// REST API Reference for DeleteObjects Operation
public virtual Task DeleteObjectsAsync(DeleteObjectsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteObjectsRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteObjectsResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DeleteObjectTagging
///
/// Removes the entire tag set from the specified object. For more information about managing
/// object tags, see
/// Object Tagging.
///
///
///
/// To use this operation, you must have permission to perform the s3:DeleteObjectTagging
/// action.
///
///
///
/// To delete tags of a specific object version, add the versionId query
/// parameter in the request. You will need permission for the s3:DeleteObjectVersionTagging
/// action.
///
///
///
/// The following operations are related to DeleteObjectTagging:
///
///
///
/// Container for the necessary parameters to execute the DeleteObjectTagging service method.
///
/// The response from the DeleteObjectTagging service method, as returned by S3.
/// REST API Reference for DeleteObjectTagging Operation
public virtual DeleteObjectTaggingResponse DeleteObjectTagging(DeleteObjectTaggingRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteObjectTaggingRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteObjectTaggingResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Removes the entire tag set from the specified object. For more information about managing
/// object tags, see
/// Object Tagging.
///
///
///
/// To use this operation, you must have permission to perform the s3:DeleteObjectTagging
/// action.
///
///
///
/// To delete tags of a specific object version, add the versionId query
/// parameter in the request. You will need permission for the s3:DeleteObjectVersionTagging
/// action.
///
///
///
/// The following operations are related to DeleteObjectTagging:
///
///
///
/// Container for the necessary parameters to execute the DeleteObjectTagging service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteObjectTagging service method, as returned by S3.
/// REST API Reference for DeleteObjectTagging Operation
public virtual Task DeleteObjectTaggingAsync(DeleteObjectTaggingRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteObjectTaggingRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteObjectTaggingResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DeletePublicAccessBlock
///
/// Removes the PublicAccessBlock configuration for an Amazon S3 bucket.
/// To use this operation, you must have the s3:PutBucketPublicAccessBlock
/// permission. For more information about permissions, see Permissions
/// Related to Bucket Subresource Operations and Managing
/// Access Permissions to Your Amazon S3 Resources.
///
///
///
/// The following operations are related to DeletePublicAccessBlock:
///
///
///
/// Container for the necessary parameters to execute the DeletePublicAccessBlock service method.
///
/// The response from the DeletePublicAccessBlock service method, as returned by S3.
/// REST API Reference for DeletePublicAccessBlock Operation
public virtual DeletePublicAccessBlockResponse DeletePublicAccessBlock(DeletePublicAccessBlockRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeletePublicAccessBlockRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeletePublicAccessBlockResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Removes the PublicAccessBlock configuration for an Amazon S3 bucket.
/// To use this operation, you must have the s3:PutBucketPublicAccessBlock
/// permission. For more information about permissions, see Permissions
/// Related to Bucket Subresource Operations and Managing
/// Access Permissions to Your Amazon S3 Resources.
///
///
///
/// The following operations are related to DeletePublicAccessBlock:
///
///
///
/// Container for the necessary parameters to execute the DeletePublicAccessBlock service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeletePublicAccessBlock service method, as returned by S3.
/// REST API Reference for DeletePublicAccessBlock Operation
public virtual Task DeletePublicAccessBlockAsync(DeletePublicAccessBlockRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DeletePublicAccessBlockRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeletePublicAccessBlockResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region GetACL
///
/// This implementation of the GET action uses the acl subresource
/// to return the access control list (ACL) of a bucket. To use GET to return
/// the ACL of the bucket, you must have READ_ACP access to the bucket. If
/// READ_ACP permission is granted to the anonymous user, you can return
/// the ACL of the bucket without using an authorization header.
///
///
///
/// 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 InvalidAccessPointAliasError
/// is returned. For more information about InvalidAccessPointAliasError,
/// see List
/// of Error Codes.
///
///
///
/// If your bucket uses the bucket owner enforced setting for S3 Object Ownership, requests
/// to read ACLs are still supported and return the bucket-owner-full-control
/// ACL with the owner being the account that created the bucket. For more information,
/// see
/// Controlling object ownership and disabling ACLs in the Amazon S3 User Guide.
///
///
///
/// The following operations are related to GetBucketAcl:
///
///
///
/// 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 InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.
///
/// The response from the GetACL service method, as returned by S3.
/// REST API Reference for GetACL Operation
public virtual GetACLResponse GetACL(string bucketName)
{
var request = new GetACLRequest();
request.BucketName = bucketName;
return GetACL(request);
}
///
/// This implementation of the GET action uses the acl subresource
/// to return the access control list (ACL) of a bucket. To use GET to return
/// the ACL of the bucket, you must have READ_ACP access to the bucket. If
/// READ_ACP permission is granted to the anonymous user, you can return
/// the ACL of the bucket without using an authorization header.
///
///
///
/// 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 InvalidAccessPointAliasError
/// is returned. For more information about InvalidAccessPointAliasError,
/// see List
/// of Error Codes.
///
///
///
/// If your bucket uses the bucket owner enforced setting for S3 Object Ownership, requests
/// to read ACLs are still supported and return the bucket-owner-full-control
/// ACL with the owner being the account that created the bucket. For more information,
/// see
/// Controlling object ownership and disabling ACLs in the Amazon S3 User Guide.
///
///
///
/// The following operations are related to GetBucketAcl:
///
///
///
/// Container for the necessary parameters to execute the GetACL service method.
///
/// The response from the GetACL service method, as returned by S3.
/// REST API Reference for GetACL Operation
public virtual GetACLResponse GetACL(GetACLRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetACLRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetACLResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// This implementation of the GET action uses the acl subresource
/// to return the access control list (ACL) of a bucket. To use GET to return
/// the ACL of the bucket, you must have READ_ACP access to the bucket. If
/// READ_ACP permission is granted to the anonymous user, you can return
/// the ACL of the bucket without using an authorization header.
///
///
///
/// 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 InvalidAccessPointAliasError
/// is returned. For more information about InvalidAccessPointAliasError,
/// see List
/// of Error Codes.
///
///
///
/// If your bucket uses the bucket owner enforced setting for S3 Object Ownership, requests
/// to read ACLs are still supported and return the bucket-owner-full-control
/// ACL with the owner being the account that created the bucket. For more information,
/// see
/// Controlling object ownership and disabling ACLs in the Amazon S3 User Guide.
///
///
///
/// The following operations are related to GetBucketAcl:
///
///
///
/// 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 InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetACL service method, as returned by S3.
/// REST API Reference for GetACL Operation
public virtual Task GetACLAsync(string bucketName, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var request = new GetACLRequest();
request.BucketName = bucketName;
return GetACLAsync(request, cancellationToken);
}
///
/// This implementation of the GET action uses the acl subresource
/// to return the access control list (ACL) of a bucket. To use GET to return
/// the ACL of the bucket, you must have READ_ACP access to the bucket. If
/// READ_ACP permission is granted to the anonymous user, you can return
/// the ACL of the bucket without using an authorization header.
///
///
///
/// 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 InvalidAccessPointAliasError
/// is returned. For more information about InvalidAccessPointAliasError,
/// see List
/// of Error Codes.
///
///
///
/// If your bucket uses the bucket owner enforced setting for S3 Object Ownership, requests
/// to read ACLs are still supported and return the bucket-owner-full-control
/// ACL with the owner being the account that created the bucket. For more information,
/// see
/// Controlling object ownership and disabling ACLs in the Amazon S3 User Guide.
///
///
///
/// The following operations are related to GetBucketAcl:
///
///
///
/// Container for the necessary parameters to execute the GetACL service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetACL service method, as returned by S3.
/// REST API Reference for GetACL Operation
public virtual Task GetACLAsync(GetACLRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = GetACLRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetACLResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region GetBucketAccelerateConfiguration
///
/// This implementation of the GET action uses the accelerate subresource
/// to return the Transfer Acceleration state of a bucket, which is either Enabled
/// or Suspended. Amazon S3 Transfer Acceleration is a bucket-level feature
/// that enables you to perform faster data transfers to and from Amazon S3.
///
///
///
/// To use this operation, you must have permission to perform the s3:GetAccelerateConfiguration
/// action. The bucket owner has this permission by default. The bucket owner can grant
/// this permission to others. For more information about permissions, see Permissions
/// Related to Bucket Subresource Operations and Managing
/// Access Permissions to your Amazon S3 Resources in the Amazon S3 User Guide.
///
///
///
/// You set the Transfer Acceleration state of an existing bucket to Enabled
/// or Suspended by using the PutBucketAccelerateConfiguration
/// operation.
///
///
///
/// A GET accelerate request does not return a state value for a bucket that
/// has no transfer acceleration state. A bucket has no Transfer Acceleration state if
/// a state has never been set on the bucket.
///
///
///
/// For more information about transfer acceleration, see Transfer
/// Acceleration in the Amazon S3 User Guide.
///
///
///
/// The following operations are related to GetBucketAccelerateConfiguration:
///
///
///
/// The name of the bucket for which the accelerate configuration is retrieved.
///
/// The response from the GetBucketAccelerateConfiguration service method, as returned by S3.
/// REST API Reference for GetBucketAccelerateConfiguration Operation
public virtual GetBucketAccelerateConfigurationResponse GetBucketAccelerateConfiguration(string bucketName)
{
var request = new GetBucketAccelerateConfigurationRequest();
request.BucketName = bucketName;
return GetBucketAccelerateConfiguration(request);
}
///
/// This implementation of the GET action uses the accelerate subresource
/// to return the Transfer Acceleration state of a bucket, which is either Enabled
/// or Suspended. Amazon S3 Transfer Acceleration is a bucket-level feature
/// that enables you to perform faster data transfers to and from Amazon S3.
///
///
///
/// To use this operation, you must have permission to perform the s3:GetAccelerateConfiguration
/// action. The bucket owner has this permission by default. The bucket owner can grant
/// this permission to others. For more information about permissions, see Permissions
/// Related to Bucket Subresource Operations and Managing
/// Access Permissions to your Amazon S3 Resources in the Amazon S3 User Guide.
///
///
///
/// You set the Transfer Acceleration state of an existing bucket to Enabled
/// or Suspended by using the PutBucketAccelerateConfiguration
/// operation.
///
///
///
/// A GET accelerate request does not return a state value for a bucket that
/// has no transfer acceleration state. A bucket has no Transfer Acceleration state if
/// a state has never been set on the bucket.
///
///
///
/// For more information about transfer acceleration, see Transfer
/// Acceleration in the Amazon S3 User Guide.
///
///
///
/// The following operations are related to GetBucketAccelerateConfiguration:
///
///
///
/// Container for the necessary parameters to execute the GetBucketAccelerateConfiguration service method.
///
/// The response from the GetBucketAccelerateConfiguration service method, as returned by S3.
/// REST API Reference for GetBucketAccelerateConfiguration Operation
public virtual GetBucketAccelerateConfigurationResponse GetBucketAccelerateConfiguration(GetBucketAccelerateConfigurationRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetBucketAccelerateConfigurationRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetBucketAccelerateConfigurationResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// This implementation of the GET action uses the accelerate subresource
/// to return the Transfer Acceleration state of a bucket, which is either Enabled
/// or Suspended. Amazon S3 Transfer Acceleration is a bucket-level feature
/// that enables you to perform faster data transfers to and from Amazon S3.
///
///
///
/// To use this operation, you must have permission to perform the s3:GetAccelerateConfiguration
/// action. The bucket owner has this permission by default. The bucket owner can grant
/// this permission to others. For more information about permissions, see Permissions
/// Related to Bucket Subresource Operations and Managing
/// Access Permissions to your Amazon S3 Resources in the Amazon S3 User Guide.
///
///
///
/// You set the Transfer Acceleration state of an existing bucket to Enabled
/// or Suspended by using the PutBucketAccelerateConfiguration
/// operation.
///
///
///
/// A GET accelerate request does not return a state value for a bucket that
/// has no transfer acceleration state. A bucket has no Transfer Acceleration state if
/// a state has never been set on the bucket.
///
///
///
/// For more information about transfer acceleration, see Transfer
/// Acceleration in the Amazon S3 User Guide.
///
///
///
/// The following operations are related to GetBucketAccelerateConfiguration:
///
///
///
/// The name of the bucket for which the accelerate configuration is retrieved.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetBucketAccelerateConfiguration service method, as returned by S3.
/// REST API Reference for GetBucketAccelerateConfiguration Operation
public virtual Task GetBucketAccelerateConfigurationAsync(string bucketName, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var request = new GetBucketAccelerateConfigurationRequest();
request.BucketName = bucketName;
return GetBucketAccelerateConfigurationAsync(request, cancellationToken);
}
///
/// This implementation of the GET action uses the accelerate subresource
/// to return the Transfer Acceleration state of a bucket, which is either Enabled
/// or Suspended. Amazon S3 Transfer Acceleration is a bucket-level feature
/// that enables you to perform faster data transfers to and from Amazon S3.
///
///
///
/// To use this operation, you must have permission to perform the s3:GetAccelerateConfiguration
/// action. The bucket owner has this permission by default. The bucket owner can grant
/// this permission to others. For more information about permissions, see Permissions
/// Related to Bucket Subresource Operations and Managing
/// Access Permissions to your Amazon S3 Resources in the Amazon S3 User Guide.
///
///
///
/// You set the Transfer Acceleration state of an existing bucket to Enabled
/// or Suspended by using the PutBucketAccelerateConfiguration
/// operation.
///
///
///
/// A GET accelerate request does not return a state value for a bucket that
/// has no transfer acceleration state. A bucket has no Transfer Acceleration state if
/// a state has never been set on the bucket.
///
///
///
/// For more information about transfer acceleration, see Transfer
/// Acceleration in the Amazon S3 User Guide.
///
///
///
/// The following operations are related to GetBucketAccelerateConfiguration:
///
///
///
/// Container for the necessary parameters to execute the GetBucketAccelerateConfiguration service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetBucketAccelerateConfiguration service method, as returned by S3.
/// REST API Reference for GetBucketAccelerateConfiguration Operation
public virtual Task GetBucketAccelerateConfigurationAsync(GetBucketAccelerateConfigurationRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = GetBucketAccelerateConfigurationRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetBucketAccelerateConfigurationResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region GetBucketAnalyticsConfiguration
///
/// This implementation of the GET action returns an analytics configuration (identified
/// by the analytics configuration ID) from the bucket.
///
///
///
/// To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration
/// action. The bucket owner has this permission by default. The bucket owner can grant
/// this permission to others. For more information about permissions, see
/// Permissions Related to Bucket Subresource Operations and Managing
/// Access Permissions to Your Amazon S3 Resources in the Amazon S3 User Guide.
///
///
///
///
/// For information about Amazon S3 analytics feature, see Amazon
/// S3 Analytics – Storage Class Analysis in the Amazon S3 User Guide.
///
///
///
/// The following operations are related to GetBucketAnalyticsConfiguration:
///
///
///
/// Container for the necessary parameters to execute the GetBucketAnalyticsConfiguration service method.
///
/// The response from the GetBucketAnalyticsConfiguration service method, as returned by S3.
/// REST API Reference for GetBucketAnalyticsConfiguration Operation
public virtual GetBucketAnalyticsConfigurationResponse GetBucketAnalyticsConfiguration(GetBucketAnalyticsConfigurationRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetBucketAnalyticsConfigurationRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetBucketAnalyticsConfigurationResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// This implementation of the GET action returns an analytics configuration (identified
/// by the analytics configuration ID) from the bucket.
///
///
///
/// To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration
/// action. The bucket owner has this permission by default. The bucket owner can grant
/// this permission to others. For more information about permissions, see
/// Permissions Related to Bucket Subresource Operations and Managing
/// Access Permissions to Your Amazon S3 Resources in the Amazon S3 User Guide.
///
///
///
///
/// For information about Amazon S3 analytics feature, see Amazon
/// S3 Analytics – Storage Class Analysis in the Amazon S3 User Guide.
///
///
///
/// The following operations are related to GetBucketAnalyticsConfiguration:
///
///
///
/// Container for the necessary parameters to execute the GetBucketAnalyticsConfiguration service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetBucketAnalyticsConfiguration service method, as returned by S3.
/// REST API Reference for GetBucketAnalyticsConfiguration Operation
public virtual Task GetBucketAnalyticsConfigurationAsync(GetBucketAnalyticsConfigurationRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = GetBucketAnalyticsConfigurationRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetBucketAnalyticsConfigurationResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region GetBucketEncryption
///
/// Returns the default encryption configuration for an Amazon S3 bucket. By default,
/// all buckets have a default encryption configuration that uses server-side encryption
/// with Amazon S3 managed keys (SSE-S3). For information about the bucket default encryption
/// feature, see Amazon
/// S3 Bucket Default Encryption in the Amazon S3 User Guide.
///
///
///
/// To use this operation, you must have permission to perform the s3:GetEncryptionConfiguration
/// action. The bucket owner has this permission by default. The bucket owner can grant
/// this permission to others. For more information about permissions, see Permissions
/// Related to Bucket Subresource Operations and Managing
/// Access Permissions to Your Amazon S3 Resources.
///
///
///
/// The following operations are related to GetBucketEncryption:
///
///
///
/// Container for the necessary parameters to execute the GetBucketEncryption service method.
///
/// The response from the GetBucketEncryption service method, as returned by S3.
/// REST API Reference for GetBucketEncryption Operation
public virtual GetBucketEncryptionResponse GetBucketEncryption(GetBucketEncryptionRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetBucketEncryptionRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetBucketEncryptionResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Returns the default encryption configuration for an Amazon S3 bucket. By default,
/// all buckets have a default encryption configuration that uses server-side encryption
/// with Amazon S3 managed keys (SSE-S3). For information about the bucket default encryption
/// feature, see Amazon
/// S3 Bucket Default Encryption in the Amazon S3 User Guide.
///
///
///
/// To use this operation, you must have permission to perform the s3:GetEncryptionConfiguration
/// action. The bucket owner has this permission by default. The bucket owner can grant
/// this permission to others. For more information about permissions, see Permissions
/// Related to Bucket Subresource Operations and Managing
/// Access Permissions to Your Amazon S3 Resources.
///
///
///
/// The following operations are related to GetBucketEncryption:
///
///
///
/// Container for the necessary parameters to execute the GetBucketEncryption service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetBucketEncryption service method, as returned by S3.
/// REST API Reference for GetBucketEncryption Operation
public virtual Task GetBucketEncryptionAsync(GetBucketEncryptionRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = GetBucketEncryptionRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetBucketEncryptionResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region GetBucketIntelligentTieringConfiguration
///
/// Gets the S3 Intelligent-Tiering configuration from the specified bucket.
///
///
///
/// The S3 Intelligent-Tiering storage class is designed to optimize storage costs by
/// automatically moving data to the most cost-effective storage access tier, without
/// performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic
/// cost savings in three low latency and high throughput access tiers. To get the lowest
/// storage cost on data that can be accessed in minutes to hours, you can choose to activate
/// additional archiving capabilities.
///
///
///
/// The S3 Intelligent-Tiering storage class is the ideal storage class for data with
/// unknown, changing, or unpredictable access patterns, independent of object size or
/// retention period. If the size of an object is less than 128 KB, it is not monitored
/// and not eligible for auto-tiering. Smaller objects can be stored, but they are always
/// charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.
///
///
///
/// For more information, see Storage
/// class for automatically optimizing frequently and infrequently accessed objects.
///
///
///
/// Operations related to GetBucketIntelligentTieringConfiguration include:
///
///
///
///
/// Container for the necessary parameters to execute the GetBucketIntelligentTieringConfiguration service method.
///
/// The response from the GetBucketIntelligentTieringConfiguration service method, as returned by S3.
/// REST API Reference for GetBucketIntelligentTieringConfiguration Operation
public virtual GetBucketIntelligentTieringConfigurationResponse GetBucketIntelligentTieringConfiguration(GetBucketIntelligentTieringConfigurationRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetBucketIntelligentTieringConfigurationRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetBucketIntelligentTieringConfigurationResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Gets the S3 Intelligent-Tiering configuration from the specified bucket.
///
///
///
/// The S3 Intelligent-Tiering storage class is designed to optimize storage costs by
/// automatically moving data to the most cost-effective storage access tier, without
/// performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic
/// cost savings in three low latency and high throughput access tiers. To get the lowest
/// storage cost on data that can be accessed in minutes to hours, you can choose to activate
/// additional archiving capabilities.
///
///
///
/// The S3 Intelligent-Tiering storage class is the ideal storage class for data with
/// unknown, changing, or unpredictable access patterns, independent of object size or
/// retention period. If the size of an object is less than 128 KB, it is not monitored
/// and not eligible for auto-tiering. Smaller objects can be stored, but they are always
/// charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.
///
///
///
/// For more information, see Storage
/// class for automatically optimizing frequently and infrequently accessed objects.
///
///
///
/// Operations related to GetBucketIntelligentTieringConfiguration include:
///
///
///
///
/// Container for the necessary parameters to execute the GetBucketIntelligentTieringConfiguration service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetBucketIntelligentTieringConfiguration service method, as returned by S3.
/// REST API Reference for GetBucketIntelligentTieringConfiguration Operation
public virtual Task GetBucketIntelligentTieringConfigurationAsync(GetBucketIntelligentTieringConfigurationRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = GetBucketIntelligentTieringConfigurationRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetBucketIntelligentTieringConfigurationResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region GetBucketInventoryConfiguration
///
/// Returns an inventory configuration (identified by the inventory configuration ID)
/// from the bucket.
///
///
///
/// To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration
/// action. The bucket owner has this permission by default and can grant this permission
/// to others. For more information about permissions, see Permissions
/// Related to Bucket Subresource Operations and Managing
/// Access Permissions to Your Amazon S3 Resources.
///
///
///
/// For information about the Amazon S3 inventory feature, see Amazon
/// S3 Inventory.
///
///
///
/// The following operations are related to GetBucketInventoryConfiguration:
///
///
///
/// Container for the necessary parameters to execute the GetBucketInventoryConfiguration service method.
///
/// The response from the GetBucketInventoryConfiguration service method, as returned by S3.
/// REST API Reference for GetBucketInventoryConfiguration Operation
public virtual GetBucketInventoryConfigurationResponse GetBucketInventoryConfiguration(GetBucketInventoryConfigurationRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetBucketInventoryConfigurationRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetBucketInventoryConfigurationResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Returns an inventory configuration (identified by the inventory configuration ID)
/// from the bucket.
///
///
///
/// To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration
/// action. The bucket owner has this permission by default and can grant this permission
/// to others. For more information about permissions, see Permissions
/// Related to Bucket Subresource Operations and Managing
/// Access Permissions to Your Amazon S3 Resources.
///
///
///
/// For information about the Amazon S3 inventory feature, see Amazon
/// S3 Inventory.
///
///
///
/// The following operations are related to GetBucketInventoryConfiguration:
///
///
///
/// Container for the necessary parameters to execute the GetBucketInventoryConfiguration service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetBucketInventoryConfiguration service method, as returned by S3.
/// REST API Reference for GetBucketInventoryConfiguration Operation
public virtual Task GetBucketInventoryConfigurationAsync(GetBucketInventoryConfigurationRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = GetBucketInventoryConfigurationRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetBucketInventoryConfigurationResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region GetBucketLocation
///
/// Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint
/// request parameter in a CreateBucket request. For more information, see
/// CreateBucket.
///
///
///
/// To use this 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 InvalidAccessPointAliasError
/// is returned. For more information about InvalidAccessPointAliasError,
/// see List
/// of Error Codes.
///
///
///
/// We recommend that you use HeadBucket
/// to return the Region that a bucket resides in. For backward compatibility, Amazon
/// S3 continues to support GetBucketLocation.
///
///
///
/// The following operations are related to GetBucketLocation:
///
///
///
/// 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 InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.
///
/// The response from the GetBucketLocation service method, as returned by S3.
/// REST API Reference for GetBucketLocation Operation
public virtual GetBucketLocationResponse GetBucketLocation(string bucketName)
{
var request = new GetBucketLocationRequest();
request.BucketName = bucketName;
return GetBucketLocation(request);
}
///
/// Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint
/// request parameter in a CreateBucket request. For more information, see
/// CreateBucket.
///
///
///
/// To use this 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 InvalidAccessPointAliasError
/// is returned. For more information about InvalidAccessPointAliasError,
/// see List
/// of Error Codes.
///
///
///
/// We recommend that you use HeadBucket
/// to return the Region that a bucket resides in. For backward compatibility, Amazon
/// S3 continues to support GetBucketLocation.
///
///
///
/// The following operations are related to GetBucketLocation:
///
///
///
/// Container for the necessary parameters to execute the GetBucketLocation service method.
///
/// The response from the GetBucketLocation service method, as returned by S3.
/// REST API Reference for GetBucketLocation Operation
public virtual GetBucketLocationResponse GetBucketLocation(GetBucketLocationRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetBucketLocationRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetBucketLocationResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint
/// request parameter in a CreateBucket request. For more information, see
/// CreateBucket.
///
///
///
/// To use this 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 InvalidAccessPointAliasError
/// is returned. For more information about InvalidAccessPointAliasError,
/// see List
/// of Error Codes.
///
///
///
/// We recommend that you use HeadBucket
/// to return the Region that a bucket resides in. For backward compatibility, Amazon
/// S3 continues to support GetBucketLocation.
///
///
///
/// The following operations are related to GetBucketLocation:
///
///
///
/// 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 InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetBucketLocation service method, as returned by S3.
/// REST API Reference for GetBucketLocation Operation
public virtual Task GetBucketLocationAsync(string bucketName, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var request = new GetBucketLocationRequest();
request.BucketName = bucketName;
return GetBucketLocationAsync(request, cancellationToken);
}
///
/// Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint
/// request parameter in a CreateBucket request. For more information, see
/// CreateBucket.
///
///
///
/// To use this 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 InvalidAccessPointAliasError
/// is returned. For more information about InvalidAccessPointAliasError,
/// see List
/// of Error Codes.
///
///
///
/// We recommend that you use HeadBucket
/// to return the Region that a bucket resides in. For backward compatibility, Amazon
/// S3 continues to support GetBucketLocation.
///
///
///
/// The following operations are related to GetBucketLocation:
///
///
///
/// Container for the necessary parameters to execute the GetBucketLocation service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetBucketLocation service method, as returned by S3.
/// REST API Reference for GetBucketLocation Operation
public virtual Task GetBucketLocationAsync(GetBucketLocationRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = GetBucketLocationRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetBucketLocationResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region GetBucketLogging
///
/// Returns the logging status of a bucket and the permissions users have to view and
/// modify that status.
///
///
///
/// The following operations are related to GetBucketLogging:
///
///
///
/// The bucket name for which to get the logging information.
///
/// The response from the GetBucketLogging service method, as returned by S3.
/// REST API Reference for GetBucketLogging Operation
public virtual GetBucketLoggingResponse GetBucketLogging(string bucketName)
{
var request = new GetBucketLoggingRequest();
request.BucketName = bucketName;
return GetBucketLogging(request);
}
///
/// Returns the logging status of a bucket and the permissions users have to view and
/// modify that status.
///
///
///
/// The following operations are related to GetBucketLogging:
///
///
///
/// Container for the necessary parameters to execute the GetBucketLogging service method.
///
/// The response from the GetBucketLogging service method, as returned by S3.
/// REST API Reference for GetBucketLogging Operation
public virtual GetBucketLoggingResponse GetBucketLogging(GetBucketLoggingRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetBucketLoggingRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetBucketLoggingResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Returns the logging status of a bucket and the permissions users have to view and
/// modify that status.
///
///
///
/// The following operations are related to GetBucketLogging:
///
///
///
/// The bucket name for which to get the logging information.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetBucketLogging service method, as returned by S3.
/// REST API Reference for GetBucketLogging Operation
public virtual Task GetBucketLoggingAsync(string bucketName, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var request = new GetBucketLoggingRequest();
request.BucketName = bucketName;
return GetBucketLoggingAsync(request, cancellationToken);
}
///
/// Returns the logging status of a bucket and the permissions users have to view and
/// modify that status.
///
///
///
/// The following operations are related to GetBucketLogging:
///
///
///
/// Container for the necessary parameters to execute the GetBucketLogging service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetBucketLogging service method, as returned by S3.
/// REST API Reference for GetBucketLogging Operation
public virtual Task GetBucketLoggingAsync(GetBucketLoggingRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = GetBucketLoggingRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetBucketLoggingResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region GetBucketMetricsConfiguration
///
/// Gets a metrics configuration (specified by the metrics configuration ID) from the
/// bucket. Note that this doesn't include the daily storage metrics.
///
///
///
/// To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration
/// action. The bucket owner has this permission by default. The bucket owner can grant
/// this permission to others. For more information about permissions, see Permissions
/// Related to Bucket Subresource Operations and Managing
/// Access Permissions to Your Amazon S3 Resources.
///
///
///
/// For information about CloudWatch request metrics for Amazon S3, see Monitoring
/// Metrics with Amazon CloudWatch.
///
///
///
/// The following operations are related to GetBucketMetricsConfiguration:
///
///
///
/// Container for the necessary parameters to execute the GetBucketMetricsConfiguration service method.
///
/// The response from the GetBucketMetricsConfiguration service method, as returned by S3.
/// REST API Reference for GetBucketMetricsConfiguration Operation
public virtual GetBucketMetricsConfigurationResponse GetBucketMetricsConfiguration(GetBucketMetricsConfigurationRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetBucketMetricsConfigurationRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetBucketMetricsConfigurationResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Gets a metrics configuration (specified by the metrics configuration ID) from the
/// bucket. Note that this doesn't include the daily storage metrics.
///
///
///
/// To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration
/// action. The bucket owner has this permission by default. The bucket owner can grant
/// this permission to others. For more information about permissions, see Permissions
/// Related to Bucket Subresource Operations and Managing
/// Access Permissions to Your Amazon S3 Resources.
///
///
///
/// For information about CloudWatch request metrics for Amazon S3, see Monitoring
/// Metrics with Amazon CloudWatch.
///
///
///
/// The following operations are related to GetBucketMetricsConfiguration:
///
///
///
/// Container for the necessary parameters to execute the GetBucketMetricsConfiguration service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetBucketMetricsConfiguration service method, as returned by S3.
/// REST API Reference for GetBucketMetricsConfiguration Operation
public virtual Task GetBucketMetricsConfigurationAsync(GetBucketMetricsConfigurationRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = GetBucketMetricsConfigurationRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetBucketMetricsConfigurationResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region GetBucketNotification
///
/// Returns the notification configuration of a bucket.
///
///
///
/// If notifications are not enabled on the bucket, the action returns an empty NotificationConfiguration
/// element.
///
///
///
/// By default, you must be the bucket owner to read the notification configuration of
/// a bucket. However, the bucket owner can use a bucket policy to grant permission to
/// other users to read this configuration with the s3:GetBucketNotification
/// permission.
///
///
///
/// 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 InvalidAccessPointAliasError
/// is returned. For more information about InvalidAccessPointAliasError,
/// see List
/// of Error Codes.
///
///
///
/// For more information about setting and reading the notification configuration on a
/// bucket, see Setting
/// Up Notification of Bucket Events. For more information about bucket policies,
/// see Using
/// Bucket Policies.
///
///
///
/// The following action is related to GetBucketNotification:
///
///
///
/// 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 InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.
///
/// The response from the GetBucketNotification service method, as returned by S3.
/// REST API Reference for GetBucketNotification Operation
public virtual GetBucketNotificationResponse GetBucketNotification(string bucketName)
{
var request = new GetBucketNotificationRequest();
request.BucketName = bucketName;
return GetBucketNotification(request);
}
///
/// Returns the notification configuration of a bucket.
///
///
///
/// If notifications are not enabled on the bucket, the action returns an empty NotificationConfiguration
/// element.
///
///
///
/// By default, you must be the bucket owner to read the notification configuration of
/// a bucket. However, the bucket owner can use a bucket policy to grant permission to
/// other users to read this configuration with the s3:GetBucketNotification
/// permission.
///
///
///
/// 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 InvalidAccessPointAliasError
/// is returned. For more information about InvalidAccessPointAliasError,
/// see List
/// of Error Codes.
///
///
///
/// For more information about setting and reading the notification configuration on a
/// bucket, see Setting
/// Up Notification of Bucket Events. For more information about bucket policies,
/// see Using
/// Bucket Policies.
///
///
///
/// The following action is related to GetBucketNotification:
///
///
///
/// Container for the necessary parameters to execute the GetBucketNotification service method.
///
/// The response from the GetBucketNotification service method, as returned by S3.
/// REST API Reference for GetBucketNotification Operation
public virtual GetBucketNotificationResponse GetBucketNotification(GetBucketNotificationRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetBucketNotificationRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetBucketNotificationResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Returns the notification configuration of a bucket.
///
///
///
/// If notifications are not enabled on the bucket, the action returns an empty NotificationConfiguration
/// element.
///
///
///
/// By default, you must be the bucket owner to read the notification configuration of
/// a bucket. However, the bucket owner can use a bucket policy to grant permission to
/// other users to read this configuration with the s3:GetBucketNotification
/// permission.
///
///
///
/// 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 InvalidAccessPointAliasError
/// is returned. For more information about InvalidAccessPointAliasError,
/// see List
/// of Error Codes.
///
///
///
/// For more information about setting and reading the notification configuration on a
/// bucket, see Setting
/// Up Notification of Bucket Events. For more information about bucket policies,
/// see Using
/// Bucket Policies.
///
///
///
/// The following action is related to GetBucketNotification:
///
///
///
/// 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 InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetBucketNotification service method, as returned by S3.
/// REST API Reference for GetBucketNotification Operation
public virtual Task GetBucketNotificationAsync(string bucketName, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var request = new GetBucketNotificationRequest();
request.BucketName = bucketName;
return GetBucketNotificationAsync(request, cancellationToken);
}
///
/// Returns the notification configuration of a bucket.
///
///
///
/// If notifications are not enabled on the bucket, the action returns an empty NotificationConfiguration
/// element.
///
///
///
/// By default, you must be the bucket owner to read the notification configuration of
/// a bucket. However, the bucket owner can use a bucket policy to grant permission to
/// other users to read this configuration with the s3:GetBucketNotification
/// permission.
///
///
///
/// 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 InvalidAccessPointAliasError
/// is returned. For more information about InvalidAccessPointAliasError,
/// see List
/// of Error Codes.
///
///
///
/// For more information about setting and reading the notification configuration on a
/// bucket, see Setting
/// Up Notification of Bucket Events. For more information about bucket policies,
/// see Using
/// Bucket Policies.
///
///
///
/// The following action is related to GetBucketNotification:
///
///
///
/// Container for the necessary parameters to execute the GetBucketNotification service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetBucketNotification service method, as returned by S3.
/// REST API Reference for GetBucketNotification Operation
public virtual Task GetBucketNotificationAsync(GetBucketNotificationRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = GetBucketNotificationRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetBucketNotificationResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region GetBucketOwnershipControls
///
/// Retrieves OwnershipControls for an Amazon S3 bucket. To use this operation,
/// you must have the s3:GetBucketOwnershipControls permission. For more
/// information about Amazon S3 permissions, see Specifying
/// permissions in a policy.
///
///
///
/// For information about Amazon S3 Object Ownership, see Using
/// Object Ownership.
///
///
///
/// The following operations are related to GetBucketOwnershipControls:
///
///
///
/// Container for the necessary parameters to execute the GetBucketOwnershipControls service method.
///
/// The response from the GetBucketOwnershipControls service method, as returned by S3.
/// REST API Reference for GetBucketOwnershipControls Operation
public virtual GetBucketOwnershipControlsResponse GetBucketOwnershipControls(GetBucketOwnershipControlsRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetBucketOwnershipControlsRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetBucketOwnershipControlsResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Retrieves OwnershipControls for an Amazon S3 bucket. To use this operation,
/// you must have the s3:GetBucketOwnershipControls permission. For more
/// information about Amazon S3 permissions, see Specifying
/// permissions in a policy.
///
///
///
/// For information about Amazon S3 Object Ownership, see Using
/// Object Ownership.
///
///
///
/// The following operations are related to GetBucketOwnershipControls:
///
///
///
/// Container for the necessary parameters to execute the GetBucketOwnershipControls service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetBucketOwnershipControls service method, as returned by S3.
/// REST API Reference for GetBucketOwnershipControls Operation
public virtual Task GetBucketOwnershipControlsAsync(GetBucketOwnershipControlsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = GetBucketOwnershipControlsRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetBucketOwnershipControlsResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region GetBucketPolicy
///
/// Returns the policy of a specified bucket. If you are using an identity other than
/// the root user of the Amazon Web Services account that owns the bucket, the calling
/// identity must have the GetBucketPolicy permissions on the specified bucket
/// and belong to the bucket owner's account in order to use this operation.
///
///
///
/// If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403
/// Access Denied error. If you have the correct permissions, but you're not using
/// an identity that belongs to the bucket owner's account, Amazon S3 returns a 405
/// Method Not Allowed error.
///
///
///
/// 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 GetBucketPolicy, PutBucketPolicy, and DeleteBucketPolicy
/// 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.
///
///
///
/// 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 InvalidAccessPointAliasError
/// is returned. For more information about InvalidAccessPointAliasError,
/// see List
/// of Error Codes.
///
///
///
/// For more information about bucket policies, see Using
/// Bucket Policies and User Policies.
///
///
///
/// The following action is related to GetBucketPolicy:
///
///
///
/// 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 InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.
///
/// The response from the GetBucketPolicy service method, as returned by S3.
/// REST API Reference for GetBucketPolicy Operation
public virtual GetBucketPolicyResponse GetBucketPolicy(string bucketName)
{
var request = new GetBucketPolicyRequest();
request.BucketName = bucketName;
return GetBucketPolicy(request);
}
///
/// Returns the policy of a specified bucket. If you are using an identity other than
/// the root user of the Amazon Web Services account that owns the bucket, the calling
/// identity must have the GetBucketPolicy permissions on the specified bucket
/// and belong to the bucket owner's account in order to use this operation.
///
///
///
/// If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403
/// Access Denied error. If you have the correct permissions, but you're not using
/// an identity that belongs to the bucket owner's account, Amazon S3 returns a 405
/// Method Not Allowed error.
///
///
///
/// 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 GetBucketPolicy, PutBucketPolicy, and DeleteBucketPolicy
/// 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.
///
///
///
/// 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 InvalidAccessPointAliasError
/// is returned. For more information about InvalidAccessPointAliasError,
/// see List
/// of Error Codes.
///
///
///
/// For more information about bucket policies, see Using
/// Bucket Policies and User Policies.
///
///
///
/// The following action is related to GetBucketPolicy:
///
///
///
/// Container for the necessary parameters to execute the GetBucketPolicy service method.
///
/// The response from the GetBucketPolicy service method, as returned by S3.
/// REST API Reference for GetBucketPolicy Operation
public virtual GetBucketPolicyResponse GetBucketPolicy(GetBucketPolicyRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetBucketPolicyRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetBucketPolicyResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Returns the policy of a specified bucket. If you are using an identity other than
/// the root user of the Amazon Web Services account that owns the bucket, the calling
/// identity must have the GetBucketPolicy permissions on the specified bucket
/// and belong to the bucket owner's account in order to use this operation.
///
///
///
/// If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403
/// Access Denied error. If you have the correct permissions, but you're not using
/// an identity that belongs to the bucket owner's account, Amazon S3 returns a 405
/// Method Not Allowed error.
///
///
///
/// 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 GetBucketPolicy, PutBucketPolicy, and DeleteBucketPolicy
/// 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.
///
///
///
/// 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 InvalidAccessPointAliasError
/// is returned. For more information about InvalidAccessPointAliasError,
/// see List
/// of Error Codes.
///
///
///
/// For more information about bucket policies, see Using
/// Bucket Policies and User Policies.
///
///
///
/// The following action is related to GetBucketPolicy:
///
///
///
/// 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 InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetBucketPolicy service method, as returned by S3.
/// REST API Reference for GetBucketPolicy Operation
public virtual Task GetBucketPolicyAsync(string bucketName, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var request = new GetBucketPolicyRequest();
request.BucketName = bucketName;
return GetBucketPolicyAsync(request, cancellationToken);
}
///
/// Returns the policy of a specified bucket. If you are using an identity other than
/// the root user of the Amazon Web Services account that owns the bucket, the calling
/// identity must have the GetBucketPolicy permissions on the specified bucket
/// and belong to the bucket owner's account in order to use this operation.
///
///
///
/// If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403
/// Access Denied error. If you have the correct permissions, but you're not using
/// an identity that belongs to the bucket owner's account, Amazon S3 returns a 405
/// Method Not Allowed error.
///
///
///
/// 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 GetBucketPolicy, PutBucketPolicy, and DeleteBucketPolicy
/// 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.
///
///
///
/// 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 InvalidAccessPointAliasError
/// is returned. For more information about InvalidAccessPointAliasError,
/// see List
/// of Error Codes.
///
///
///
/// For more information about bucket policies, see Using
/// Bucket Policies and User Policies.
///
///
///
/// The following action is related to GetBucketPolicy:
///
///
///
/// Container for the necessary parameters to execute the GetBucketPolicy service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetBucketPolicy service method, as returned by S3.
/// REST API Reference for GetBucketPolicy Operation
public virtual Task GetBucketPolicyAsync(GetBucketPolicyRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = GetBucketPolicyRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetBucketPolicyResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region GetBucketPolicyStatus
///
/// Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket
/// is public. In order to use this operation, you must have the s3:GetBucketPolicyStatus
/// permission. For more information about Amazon S3 permissions, see Specifying
/// Permissions in a Policy.
///
///
///
/// For more information about when Amazon S3 considers a bucket public, see The
/// Meaning of "Public".
///
///
///
/// The following operations are related to GetBucketPolicyStatus:
///
///
///
/// Container for the necessary parameters to execute the GetBucketPolicyStatus service method.
///
/// The response from the GetBucketPolicyStatus service method, as returned by S3.
/// REST API Reference for GetBucketPolicyStatus Operation
public virtual GetBucketPolicyStatusResponse GetBucketPolicyStatus(GetBucketPolicyStatusRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetBucketPolicyStatusRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetBucketPolicyStatusResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket
/// is public. In order to use this operation, you must have the s3:GetBucketPolicyStatus
/// permission. For more information about Amazon S3 permissions, see Specifying
/// Permissions in a Policy.
///
///
///
/// For more information about when Amazon S3 considers a bucket public, see The
/// Meaning of "Public".
///
///
///
/// The following operations are related to GetBucketPolicyStatus:
///
///
///
/// Container for the necessary parameters to execute the GetBucketPolicyStatus service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetBucketPolicyStatus service method, as returned by S3.
/// REST API Reference for GetBucketPolicyStatus Operation
public virtual Task GetBucketPolicyStatusAsync(GetBucketPolicyStatusRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = GetBucketPolicyStatusRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetBucketPolicyStatusResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region GetBucketReplication
///
/// Retrieves the replication configuration for the given Amazon S3 bucket.
///
/// Container for the necessary parameters to execute the GetBucketReplication service method.
///
/// The response from the GetBucketReplication service method, as returned by S3.
/// REST API Reference for GetBucketReplication Operation
public virtual GetBucketReplicationResponse GetBucketReplication(GetBucketReplicationRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetBucketReplicationRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetBucketReplicationResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Retrieves the replication configuration for the given Amazon S3 bucket.
///
/// Container for the necessary parameters to execute the GetBucketReplication service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetBucketReplication service method, as returned by S3.
/// REST API Reference for GetBucketReplication Operation
public virtual Task GetBucketReplicationAsync(GetBucketReplicationRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = GetBucketReplicationRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetBucketReplicationResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region GetBucketRequestPayment
///
/// Returns the request payment configuration of a bucket. To use this version of the
/// operation, you must be the bucket owner. For more information, see Requester
/// Pays Buckets.
///
///
///
/// The following operations are related to GetBucketRequestPayment:
///
///
///
/// The name of the bucket for which to get the payment request configuration
///
/// The response from the GetBucketRequestPayment service method, as returned by S3.
/// REST API Reference for GetBucketRequestPayment Operation
public virtual GetBucketRequestPaymentResponse GetBucketRequestPayment(string bucketName)
{
var request = new GetBucketRequestPaymentRequest();
request.BucketName = bucketName;
return GetBucketRequestPayment(request);
}
///
/// Returns the request payment configuration of a bucket. To use this version of the
/// operation, you must be the bucket owner. For more information, see Requester
/// Pays Buckets.
///
///
///
/// The following operations are related to GetBucketRequestPayment:
///
///
///
/// Container for the necessary parameters to execute the GetBucketRequestPayment service method.
///
/// The response from the GetBucketRequestPayment service method, as returned by S3.
/// REST API Reference for GetBucketRequestPayment Operation
public virtual GetBucketRequestPaymentResponse GetBucketRequestPayment(GetBucketRequestPaymentRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetBucketRequestPaymentRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetBucketRequestPaymentResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Returns the request payment configuration of a bucket. To use this version of the
/// operation, you must be the bucket owner. For more information, see Requester
/// Pays Buckets.
///
///
///
/// The following operations are related to GetBucketRequestPayment:
///
///
///
/// The name of the bucket for which to get the payment request configuration
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetBucketRequestPayment service method, as returned by S3.
/// REST API Reference for GetBucketRequestPayment Operation
public virtual Task GetBucketRequestPaymentAsync(string bucketName, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var request = new GetBucketRequestPaymentRequest();
request.BucketName = bucketName;
return GetBucketRequestPaymentAsync(request, cancellationToken);
}
///
/// Returns the request payment configuration of a bucket. To use this version of the
/// operation, you must be the bucket owner. For more information, see Requester
/// Pays Buckets.
///
///
///
/// The following operations are related to GetBucketRequestPayment:
///
///
///
/// Container for the necessary parameters to execute the GetBucketRequestPayment service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetBucketRequestPayment service method, as returned by S3.
/// REST API Reference for GetBucketRequestPayment Operation
public virtual Task GetBucketRequestPaymentAsync(GetBucketRequestPaymentRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = GetBucketRequestPaymentRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetBucketRequestPaymentResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region GetBucketTagging
///
/// Returns the tag set associated with the bucket.
///
///
///
/// To use this operation, you must have permission to perform the s3:GetBucketTagging
/// action. By default, the bucket owner has this permission and can grant this permission
/// to others.
///
///
///
/// GetBucketTagging has the following special error:
///
/// -
///
/// Error code:
NoSuchTagSet
///
/// -
///
/// Description: There is no tag set associated with the bucket.
///
///
///
/// The following operations are related to GetBucketTagging:
///
///
///
/// Container for the necessary parameters to execute the GetBucketTagging service method.
///
/// The response from the GetBucketTagging service method, as returned by S3.
/// REST API Reference for GetBucketTagging Operation
public virtual GetBucketTaggingResponse GetBucketTagging(GetBucketTaggingRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetBucketTaggingRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetBucketTaggingResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Returns the tag set associated with the bucket.
///
///
///
/// To use this operation, you must have permission to perform the s3:GetBucketTagging
/// action. By default, the bucket owner has this permission and can grant this permission
/// to others.
///
///
///
/// GetBucketTagging has the following special error:
///
/// -
///
/// Error code:
NoSuchTagSet
///
/// -
///
/// Description: There is no tag set associated with the bucket.
///
///
///
/// The following operations are related to GetBucketTagging:
///
///
///
/// Container for the necessary parameters to execute the GetBucketTagging service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetBucketTagging service method, as returned by S3.
/// REST API Reference for GetBucketTagging Operation
public virtual Task GetBucketTaggingAsync(GetBucketTaggingRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = GetBucketTaggingRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetBucketTaggingResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region GetBucketVersioning
///
/// Returns the versioning state of a bucket.
///
///
///
/// To retrieve the versioning state of a bucket, you must be the bucket owner.
///
///
///
/// This implementation also returns the MFA Delete status of the versioning state. If
/// the MFA Delete status is enabled, the bucket owner must use an authentication
/// device to change the versioning state of the bucket.
///
///
///
/// The following operations are related to GetBucketVersioning:
///
///
///
/// The name of the bucket for which to get the versioning information.
///
/// The response from the GetBucketVersioning service method, as returned by S3.
/// REST API Reference for GetBucketVersioning Operation
public virtual GetBucketVersioningResponse GetBucketVersioning(string bucketName)
{
var request = new GetBucketVersioningRequest();
request.BucketName = bucketName;
return GetBucketVersioning(request);
}
///
/// Returns the versioning state of a bucket.
///
///
///
/// To retrieve the versioning state of a bucket, you must be the bucket owner.
///
///
///
/// This implementation also returns the MFA Delete status of the versioning state. If
/// the MFA Delete status is enabled, the bucket owner must use an authentication
/// device to change the versioning state of the bucket.
///
///
///
/// The following operations are related to GetBucketVersioning:
///
///
///
/// Container for the necessary parameters to execute the GetBucketVersioning service method.
///
/// The response from the GetBucketVersioning service method, as returned by S3.
/// REST API Reference for GetBucketVersioning Operation
public virtual GetBucketVersioningResponse GetBucketVersioning(GetBucketVersioningRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetBucketVersioningRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetBucketVersioningResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Returns the versioning state of a bucket.
///
///
///
/// To retrieve the versioning state of a bucket, you must be the bucket owner.
///
///
///
/// This implementation also returns the MFA Delete status of the versioning state. If
/// the MFA Delete status is enabled, the bucket owner must use an authentication
/// device to change the versioning state of the bucket.
///
///
///
/// The following operations are related to GetBucketVersioning:
///
///
///
/// The name of the bucket for which to get the versioning information.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetBucketVersioning service method, as returned by S3.
/// REST API Reference for GetBucketVersioning Operation
public virtual Task GetBucketVersioningAsync(string bucketName, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var request = new GetBucketVersioningRequest();
request.BucketName = bucketName;
return GetBucketVersioningAsync(request, cancellationToken);
}
///
/// Returns the versioning state of a bucket.
///
///
///
/// To retrieve the versioning state of a bucket, you must be the bucket owner.
///
///
///
/// This implementation also returns the MFA Delete status of the versioning state. If
/// the MFA Delete status is enabled, the bucket owner must use an authentication
/// device to change the versioning state of the bucket.
///
///
///
/// The following operations are related to GetBucketVersioning:
///
///
///
/// Container for the necessary parameters to execute the GetBucketVersioning service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetBucketVersioning service method, as returned by S3.
/// REST API Reference for GetBucketVersioning Operation
public virtual Task GetBucketVersioningAsync(GetBucketVersioningRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = GetBucketVersioningRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetBucketVersioningResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region GetBucketWebsite
///
/// Returns the website configuration for a bucket. To host website on Amazon S3, you
/// can configure a bucket as website by adding a website configuration. For more information
/// about hosting websites, see Hosting
/// Websites on Amazon S3.
///
///
///
/// This GET action requires the S3:GetBucketWebsite permission. By default,
/// only the bucket owner can read the bucket website configuration. However, bucket owners
/// can allow other users to read the website configuration by writing a bucket policy
/// granting them the S3:GetBucketWebsite permission.
///
///
///
/// The following operations are related to GetBucketWebsite:
///
///
///
/// The bucket name for which to get the website configuration.
///
/// The response from the GetBucketWebsite service method, as returned by S3.
/// REST API Reference for GetBucketWebsite Operation
public virtual GetBucketWebsiteResponse GetBucketWebsite(string bucketName)
{
var request = new GetBucketWebsiteRequest();
request.BucketName = bucketName;
return GetBucketWebsite(request);
}
///
/// Returns the website configuration for a bucket. To host website on Amazon S3, you
/// can configure a bucket as website by adding a website configuration. For more information
/// about hosting websites, see Hosting
/// Websites on Amazon S3.
///
///
///
/// This GET action requires the S3:GetBucketWebsite permission. By default,
/// only the bucket owner can read the bucket website configuration. However, bucket owners
/// can allow other users to read the website configuration by writing a bucket policy
/// granting them the S3:GetBucketWebsite permission.
///
///
///
/// The following operations are related to GetBucketWebsite:
///
///
///
/// Container for the necessary parameters to execute the GetBucketWebsite service method.
///
/// The response from the GetBucketWebsite service method, as returned by S3.
/// REST API Reference for GetBucketWebsite Operation
public virtual GetBucketWebsiteResponse GetBucketWebsite(GetBucketWebsiteRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetBucketWebsiteRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetBucketWebsiteResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Returns the website configuration for a bucket. To host website on Amazon S3, you
/// can configure a bucket as website by adding a website configuration. For more information
/// about hosting websites, see Hosting
/// Websites on Amazon S3.
///
///
///
/// This GET action requires the S3:GetBucketWebsite permission. By default,
/// only the bucket owner can read the bucket website configuration. However, bucket owners
/// can allow other users to read the website configuration by writing a bucket policy
/// granting them the S3:GetBucketWebsite permission.
///
///
///
/// The following operations are related to GetBucketWebsite:
///
///
///
/// The bucket name for which to get the website configuration.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetBucketWebsite service method, as returned by S3.
/// REST API Reference for GetBucketWebsite Operation
public virtual Task GetBucketWebsiteAsync(string bucketName, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var request = new GetBucketWebsiteRequest();
request.BucketName = bucketName;
return GetBucketWebsiteAsync(request, cancellationToken);
}
///
/// Returns the website configuration for a bucket. To host website on Amazon S3, you
/// can configure a bucket as website by adding a website configuration. For more information
/// about hosting websites, see Hosting
/// Websites on Amazon S3.
///
///
///
/// This GET action requires the S3:GetBucketWebsite permission. By default,
/// only the bucket owner can read the bucket website configuration. However, bucket owners
/// can allow other users to read the website configuration by writing a bucket policy
/// granting them the S3:GetBucketWebsite permission.
///
///
///
/// The following operations are related to GetBucketWebsite:
///
///
///
/// Container for the necessary parameters to execute the GetBucketWebsite service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetBucketWebsite service method, as returned by S3.
/// REST API Reference for GetBucketWebsite Operation
public virtual Task GetBucketWebsiteAsync(GetBucketWebsiteRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = GetBucketWebsiteRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetBucketWebsiteResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region GetCORSConfiguration
///
/// Returns the Cross-Origin Resource Sharing (CORS) configuration information set for
/// the bucket.
///
///
///
/// To use this operation, you must have permission to perform the s3:GetBucketCORS
/// action. By default, the bucket owner has this permission and can grant it to others.
///
///
///
/// 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 InvalidAccessPointAliasError
/// is returned. For more information about InvalidAccessPointAliasError,
/// see List
/// of Error Codes.
///
///
///
/// For more information about CORS, see
/// Enabling Cross-Origin Resource Sharing.
///
///
///
/// The following operations are related to GetBucketCors:
///
///
///
/// 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 InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.
///
/// The response from the GetCORSConfiguration service method, as returned by S3.
/// REST API Reference for GetCORSConfiguration Operation
public virtual GetCORSConfigurationResponse GetCORSConfiguration(string bucketName)
{
var request = new GetCORSConfigurationRequest();
request.BucketName = bucketName;
return GetCORSConfiguration(request);
}
///
/// Returns the Cross-Origin Resource Sharing (CORS) configuration information set for
/// the bucket.
///
///
///
/// To use this operation, you must have permission to perform the s3:GetBucketCORS
/// action. By default, the bucket owner has this permission and can grant it to others.
///
///
///
/// 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 InvalidAccessPointAliasError
/// is returned. For more information about InvalidAccessPointAliasError,
/// see List
/// of Error Codes.
///
///
///
/// For more information about CORS, see
/// Enabling Cross-Origin Resource Sharing.
///
///
///
/// The following operations are related to GetBucketCors:
///
///
///
/// Container for the necessary parameters to execute the GetCORSConfiguration service method.
///
/// The response from the GetCORSConfiguration service method, as returned by S3.
/// REST API Reference for GetCORSConfiguration Operation
public virtual GetCORSConfigurationResponse GetCORSConfiguration(GetCORSConfigurationRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetCORSConfigurationRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetCORSConfigurationResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Returns the Cross-Origin Resource Sharing (CORS) configuration information set for
/// the bucket.
///
///
///
/// To use this operation, you must have permission to perform the s3:GetBucketCORS
/// action. By default, the bucket owner has this permission and can grant it to others.
///
///
///
/// 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 InvalidAccessPointAliasError
/// is returned. For more information about InvalidAccessPointAliasError,
/// see List
/// of Error Codes.
///
///
///
/// For more information about CORS, see
/// Enabling Cross-Origin Resource Sharing.
///
///
///
/// The following operations are related to GetBucketCors:
///
///
///
/// 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 InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetCORSConfiguration service method, as returned by S3.
/// REST API Reference for GetCORSConfiguration Operation
public virtual Task GetCORSConfigurationAsync(string bucketName, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var request = new GetCORSConfigurationRequest();
request.BucketName = bucketName;
return GetCORSConfigurationAsync(request, cancellationToken);
}
///
/// Returns the Cross-Origin Resource Sharing (CORS) configuration information set for
/// the bucket.
///
///
///
/// To use this operation, you must have permission to perform the s3:GetBucketCORS
/// action. By default, the bucket owner has this permission and can grant it to others.
///
///
///
/// 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 InvalidAccessPointAliasError
/// is returned. For more information about InvalidAccessPointAliasError,
/// see List
/// of Error Codes.
///
///
///
/// For more information about CORS, see
/// Enabling Cross-Origin Resource Sharing.
///
///
///
/// The following operations are related to GetBucketCors:
///
///
///
/// Container for the necessary parameters to execute the GetCORSConfiguration service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetCORSConfiguration service method, as returned by S3.
/// REST API Reference for GetCORSConfiguration Operation
public virtual Task GetCORSConfigurationAsync(GetCORSConfigurationRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = GetCORSConfigurationRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetCORSConfigurationResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region GetLifecycleConfiguration
///
///
///
/// Bucket lifecycle configuration now supports specifying a lifecycle rule using an object
/// key name prefix, one or more object tags, or a combination of both. Accordingly, this
/// section describes the latest API. The response describes the new filter element that
/// you can use to specify a filter to select a subset of objects to which the rule applies.
/// If you are using a previous version of the lifecycle configuration, it still works.
/// For the earlier action, see GetBucketLifecycle.
///
///
///
/// Returns the lifecycle configuration information set on the bucket. For information
/// about lifecycle configuration, see Object
/// Lifecycle Management.
///
///
///
/// To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration
/// action. The bucket owner has this permission, by default. The bucket owner can grant
/// this permission to others. For more information about permissions, see Permissions
/// Related to Bucket Subresource Operations and Managing
/// Access Permissions to Your Amazon S3 Resources.
///
///
///
/// GetBucketLifecycleConfiguration has the following special error:
///
/// -
///
/// Error code:
NoSuchLifecycleConfiguration
///
/// -
///
/// Description: The lifecycle configuration does not exist.
///
///
-
///
/// HTTP Status Code: 404 Not Found
///
///
-
///
/// SOAP Fault Code Prefix: Client
///
///
///
/// The following operations are related to GetBucketLifecycleConfiguration:
///
///
///
/// The name of the bucket for which to get the lifecycle information.
///
/// The response from the GetLifecycleConfiguration service method, as returned by S3.
/// REST API Reference for GetLifecycleConfiguration Operation
public virtual GetLifecycleConfigurationResponse GetLifecycleConfiguration(string bucketName)
{
var request = new GetLifecycleConfigurationRequest();
request.BucketName = bucketName;
return GetLifecycleConfiguration(request);
}
///
///
///
/// Bucket lifecycle configuration now supports specifying a lifecycle rule using an object
/// key name prefix, one or more object tags, or a combination of both. Accordingly, this
/// section describes the latest API. The response describes the new filter element that
/// you can use to specify a filter to select a subset of objects to which the rule applies.
/// If you are using a previous version of the lifecycle configuration, it still works.
/// For the earlier action, see GetBucketLifecycle.
///
///
///
/// Returns the lifecycle configuration information set on the bucket. For information
/// about lifecycle configuration, see Object
/// Lifecycle Management.
///
///
///
/// To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration
/// action. The bucket owner has this permission, by default. The bucket owner can grant
/// this permission to others. For more information about permissions, see Permissions
/// Related to Bucket Subresource Operations and Managing
/// Access Permissions to Your Amazon S3 Resources.
///
///
///
/// GetBucketLifecycleConfiguration has the following special error:
///
/// -
///
/// Error code:
NoSuchLifecycleConfiguration
///
/// -
///
/// Description: The lifecycle configuration does not exist.
///
///
-
///
/// HTTP Status Code: 404 Not Found
///
///
-
///
/// SOAP Fault Code Prefix: Client
///
///
///
/// The following operations are related to GetBucketLifecycleConfiguration:
///
///
///
/// Container for the necessary parameters to execute the GetLifecycleConfiguration service method.
///
/// The response from the GetLifecycleConfiguration service method, as returned by S3.
/// REST API Reference for GetLifecycleConfiguration Operation
public virtual GetLifecycleConfigurationResponse GetLifecycleConfiguration(GetLifecycleConfigurationRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetLifecycleConfigurationRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetLifecycleConfigurationResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
///
///
/// Bucket lifecycle configuration now supports specifying a lifecycle rule using an object
/// key name prefix, one or more object tags, or a combination of both. Accordingly, this
/// section describes the latest API. The response describes the new filter element that
/// you can use to specify a filter to select a subset of objects to which the rule applies.
/// If you are using a previous version of the lifecycle configuration, it still works.
/// For the earlier action, see GetBucketLifecycle.
///
///
///
/// Returns the lifecycle configuration information set on the bucket. For information
/// about lifecycle configuration, see Object
/// Lifecycle Management.
///
///
///
/// To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration
/// action. The bucket owner has this permission, by default. The bucket owner can grant
/// this permission to others. For more information about permissions, see Permissions
/// Related to Bucket Subresource Operations and Managing
/// Access Permissions to Your Amazon S3 Resources.
///
///
///
/// GetBucketLifecycleConfiguration has the following special error:
///
/// -
///
/// Error code:
NoSuchLifecycleConfiguration
///
/// -
///
/// Description: The lifecycle configuration does not exist.
///
///
-
///
/// HTTP Status Code: 404 Not Found
///
///
-
///
/// SOAP Fault Code Prefix: Client
///
///
///
/// The following operations are related to GetBucketLifecycleConfiguration:
///
///
///
/// The name of the bucket for which to get the lifecycle information.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetLifecycleConfiguration service method, as returned by S3.
/// REST API Reference for GetLifecycleConfiguration Operation
public virtual Task GetLifecycleConfigurationAsync(string bucketName, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var request = new GetLifecycleConfigurationRequest();
request.BucketName = bucketName;
return GetLifecycleConfigurationAsync(request, cancellationToken);
}
///
///
///
/// Bucket lifecycle configuration now supports specifying a lifecycle rule using an object
/// key name prefix, one or more object tags, or a combination of both. Accordingly, this
/// section describes the latest API. The response describes the new filter element that
/// you can use to specify a filter to select a subset of objects to which the rule applies.
/// If you are using a previous version of the lifecycle configuration, it still works.
/// For the earlier action, see GetBucketLifecycle.
///
///
///
/// Returns the lifecycle configuration information set on the bucket. For information
/// about lifecycle configuration, see Object
/// Lifecycle Management.
///
///
///
/// To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration
/// action. The bucket owner has this permission, by default. The bucket owner can grant
/// this permission to others. For more information about permissions, see Permissions
/// Related to Bucket Subresource Operations and Managing
/// Access Permissions to Your Amazon S3 Resources.
///
///
///
/// GetBucketLifecycleConfiguration has the following special error:
///
/// -
///
/// Error code:
NoSuchLifecycleConfiguration
///
/// -
///
/// Description: The lifecycle configuration does not exist.
///
///
-
///
/// HTTP Status Code: 404 Not Found
///
///
-
///
/// SOAP Fault Code Prefix: Client
///
///
///
/// The following operations are related to GetBucketLifecycleConfiguration:
///
///
///
/// Container for the necessary parameters to execute the GetLifecycleConfiguration service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetLifecycleConfiguration service method, as returned by S3.
/// REST API Reference for GetLifecycleConfiguration Operation
public virtual Task GetLifecycleConfigurationAsync(GetLifecycleConfigurationRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = GetLifecycleConfigurationRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetLifecycleConfigurationResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region GetObject
///
/// Retrieves objects from Amazon S3. To use GET, you must have READ
/// access to the object. If you grant READ access to the anonymous user,
/// you can return the object without using an authorization header.
///
///
///
/// An Amazon S3 bucket has no directory hierarchy such as you would find in a typical
/// computer file system. You can, however, create a logical hierarchy by using object
/// key names that imply a folder structure. For example, instead of naming an object
/// sample.jpg, you can name it photos/2006/February/sample.jpg.
///
///
///
/// To get an object from such a logical hierarchy, specify the full key name for the
/// object in the GET operation. For a virtual hosted-style request example,
/// if you have the object photos/2006/February/sample.jpg, specify the resource
/// as /photos/2006/February/sample.jpg. For a path-style request example,
/// if you have the object photos/2006/February/sample.jpg in the bucket
/// named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg.
/// For more information about request types, see HTTP
/// Host Header Bucket Specification.
///
///
///
/// For more information about returning the ACL of an object, see GetObjectAcl.
///
///
///
/// If the object you are retrieving is stored in the S3 Glacier 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 RestoreObject.
/// Otherwise, this action returns an InvalidObjectState error. For information
/// about restoring archived objects, see Restoring
/// Archived Objects.
///
///
///
/// Encryption request headers, like x-amz-server-side-encryption, should
/// not be sent for GET requests if your object uses server-side encryption with 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.
///
///
///
/// If you encrypt an object by using server-side encryption with customer-provided encryption
/// keys (SSE-C) when you store the object in Amazon S3, then when you GET the object,
/// you must use the following headers:
///
/// -
///
///
x-amz-server-side-encryption-customer-algorithm
///
/// -
///
///
x-amz-server-side-encryption-customer-key
///
/// -
///
///
x-amz-server-side-encryption-customer-key-MD5
///
///
///
/// For more information about SSE-C, see Server-Side
/// Encryption (Using Customer-Provided Encryption Keys).
///
///
///
/// Assuming you have the relevant permission to read object tags, the response also returns
/// the x-amz-tagging-count header that provides the count of number of tags
/// associated with the object. You can use GetObjectTagging
/// to retrieve the tag set associated with an object.
///
/// - Permissions
-
///
/// You need the relevant read object (or version) permission for this operation. For
/// more information, see Specifying
/// Permissions in a Policy. If the object that you request doesn’t exist, the error
/// that Amazon S3 returns depends on whether you also have the
s3:ListBucket
/// permission.
///
///
///
/// If you have the s3:ListBucket permission on the bucket, Amazon S3 returns
/// an HTTP status code 404 (Not Found) error.
///
///
///
/// If you don’t have the s3:ListBucket permission, Amazon S3 returns an
/// HTTP status code 403 ("access denied") error.
///
/// - Versioning
-
///
/// By default, the
GET action returns the current version of an object.
/// To return a different version, use the versionId subresource.
///
/// -
///
/// If you supply a
versionId, you need the s3:GetObjectVersion
/// permission to access a specific version of an object. If you request a specific version,
/// you do not need to have the s3:GetObject permission. If you request the
/// current version without a specific version ID, only s3:GetObject permission
/// is required. s3:GetObjectVersion permission won't be required.
///
/// -
///
/// If the current version of the object is a delete marker, Amazon S3 behaves as if the
/// object was deleted and includes
x-amz-delete-marker: true in the response.
///
///
///
/// For more information about versioning, see PutBucketVersioning.
///
///
/// - Overriding Response Header Values
-
///
/// There are times when you want to override certain response header values in a
GET
/// response. For example, you might override the Content-Disposition response
/// header value in your GET request.
///
///
///
/// You can override values for a set of response headers using the following query parameters.
/// These response header values are sent only on a successful request, that is, when
/// status code 200 OK is returned. The set of headers you can override using these parameters
/// is a subset of the headers that Amazon S3 accepts when you create an object. The response
/// headers that you can override for the GET response are Content-Type,
/// Content-Language, Expires, Cache-Control, Content-Disposition,
/// and Content-Encoding. To override these header values in the GET
/// response, you use the following request parameters.
///
///
///
/// 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.
///
/// -
///
///
response-content-type
///
/// -
///
///
response-content-language
///
/// -
///
///
response-expires
///
/// -
///
///
response-cache-control
///
/// -
///
///
response-content-disposition
///
/// -
///
///
response-content-encoding
///
///
- Overriding Response Header Values
-
///
/// If both of the
If-Match and If-Unmodified-Since headers
/// are present in the request as follows: If-Match condition evaluates to
/// true, and; If-Unmodified-Since condition evaluates to false;
/// then, S3 returns 200 OK and the data requested.
///
///
///
/// If both of the If-None-Match and If-Modified-Since headers
/// are present in the request as follows: If-None-Match condition evaluates
/// to false, and; If-Modified-Since condition evaluates to
/// true; then, S3 returns 304 Not Modified response code.
///
///
///
/// For more information about conditional requests, see RFC
/// 7232.
///
///
///
/// The following operations are related to GetObject:
///
///
///
/// 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 AccessPointName-AccountId.s3-accesspoint.Region.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 Using access points in the Amazon S3 User Guide. When using an Object Lambda access point the hostname takes the form AccessPointName-AccountId.s3-object-lambda.Region.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 AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. 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 What is S3 on Outposts? in the Amazon S3 User Guide.
/// Key of the object to get.
///
/// The response from the GetObject service method, as returned by S3.
/// REST API Reference for GetObject Operation
public virtual GetObjectResponse GetObject(string bucketName, string key)
{
var request = new GetObjectRequest();
request.BucketName = bucketName;
request.Key = key;
return GetObject(request);
}
///
/// Retrieves objects from Amazon S3. To use GET, you must have READ
/// access to the object. If you grant READ access to the anonymous user,
/// you can return the object without using an authorization header.
///
///
///
/// An Amazon S3 bucket has no directory hierarchy such as you would find in a typical
/// computer file system. You can, however, create a logical hierarchy by using object
/// key names that imply a folder structure. For example, instead of naming an object
/// sample.jpg, you can name it photos/2006/February/sample.jpg.
///
///
///
/// To get an object from such a logical hierarchy, specify the full key name for the
/// object in the GET operation. For a virtual hosted-style request example,
/// if you have the object photos/2006/February/sample.jpg, specify the resource
/// as /photos/2006/February/sample.jpg. For a path-style request example,
/// if you have the object photos/2006/February/sample.jpg in the bucket
/// named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg.
/// For more information about request types, see HTTP
/// Host Header Bucket Specification.
///
///
///
/// For more information about returning the ACL of an object, see GetObjectAcl.
///
///
///
/// If the object you are retrieving is stored in the S3 Glacier 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 RestoreObject.
/// Otherwise, this action returns an InvalidObjectState error. For information
/// about restoring archived objects, see Restoring
/// Archived Objects.
///
///
///
/// Encryption request headers, like x-amz-server-side-encryption, should
/// not be sent for GET requests if your object uses server-side encryption with 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.
///
///
///
/// If you encrypt an object by using server-side encryption with customer-provided encryption
/// keys (SSE-C) when you store the object in Amazon S3, then when you GET the object,
/// you must use the following headers:
///
/// -
///
///
x-amz-server-side-encryption-customer-algorithm
///
/// -
///
///
x-amz-server-side-encryption-customer-key
///
/// -
///
///
x-amz-server-side-encryption-customer-key-MD5
///
///
///
/// For more information about SSE-C, see Server-Side
/// Encryption (Using Customer-Provided Encryption Keys).
///
///
///
/// Assuming you have the relevant permission to read object tags, the response also returns
/// the x-amz-tagging-count header that provides the count of number of tags
/// associated with the object. You can use GetObjectTagging
/// to retrieve the tag set associated with an object.
///
/// - Permissions
-
///
/// You need the relevant read object (or version) permission for this operation. For
/// more information, see Specifying
/// Permissions in a Policy. If the object that you request doesn’t exist, the error
/// that Amazon S3 returns depends on whether you also have the
s3:ListBucket
/// permission.
///
///
///
/// If you have the s3:ListBucket permission on the bucket, Amazon S3 returns
/// an HTTP status code 404 (Not Found) error.
///
///
///
/// If you don’t have the s3:ListBucket permission, Amazon S3 returns an
/// HTTP status code 403 ("access denied") error.
///
/// - Versioning
-
///
/// By default, the
GET action returns the current version of an object.
/// To return a different version, use the versionId subresource.
///
/// -
///
/// If you supply a
versionId, you need the s3:GetObjectVersion
/// permission to access a specific version of an object. If you request a specific version,
/// you do not need to have the s3:GetObject permission. If you request the
/// current version without a specific version ID, only s3:GetObject permission
/// is required. s3:GetObjectVersion permission won't be required.
///
/// -
///
/// If the current version of the object is a delete marker, Amazon S3 behaves as if the
/// object was deleted and includes
x-amz-delete-marker: true in the response.
///
///
///
/// For more information about versioning, see PutBucketVersioning.
///
///
/// - Overriding Response Header Values
-
///
/// There are times when you want to override certain response header values in a
GET
/// response. For example, you might override the Content-Disposition response
/// header value in your GET request.
///
///
///
/// You can override values for a set of response headers using the following query parameters.
/// These response header values are sent only on a successful request, that is, when
/// status code 200 OK is returned. The set of headers you can override using these parameters
/// is a subset of the headers that Amazon S3 accepts when you create an object. The response
/// headers that you can override for the GET response are Content-Type,
/// Content-Language, Expires, Cache-Control, Content-Disposition,
/// and Content-Encoding. To override these header values in the GET
/// response, you use the following request parameters.
///
///
///
/// 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.
///
/// -
///
///
response-content-type
///
/// -
///
///
response-content-language
///
/// -
///
///
response-expires
///
/// -
///
///
response-cache-control
///
/// -
///
///
response-content-disposition
///
/// -
///
///
response-content-encoding
///
///
- Overriding Response Header Values
-
///
/// If both of the
If-Match and If-Unmodified-Since headers
/// are present in the request as follows: If-Match condition evaluates to
/// true, and; If-Unmodified-Since condition evaluates to false;
/// then, S3 returns 200 OK and the data requested.
///
///
///
/// If both of the If-None-Match and If-Modified-Since headers
/// are present in the request as follows: If-None-Match condition evaluates
/// to false, and; If-Modified-Since condition evaluates to
/// true; then, S3 returns 304 Not Modified response code.
///
///
///
/// For more information about conditional requests, see RFC
/// 7232.
///
///
///
/// The following operations are related to GetObject:
///
///
///
/// 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 AccessPointName-AccountId.s3-accesspoint.Region.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 Using access points in the Amazon S3 User Guide. When using an Object Lambda access point the hostname takes the form AccessPointName-AccountId.s3-object-lambda.Region.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 AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. 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 What is S3 on Outposts? in the Amazon S3 User Guide.
/// Key of the object to get.
/// VersionId used to reference a specific version of the object.
///
/// The response from the GetObject service method, as returned by S3.
/// REST API Reference for GetObject Operation
public virtual GetObjectResponse GetObject(string bucketName, string key, string versionId)
{
var request = new GetObjectRequest();
request.BucketName = bucketName;
request.Key = key;
request.VersionId = versionId;
return GetObject(request);
}
///
/// Retrieves objects from Amazon S3. To use GET, you must have READ
/// access to the object. If you grant READ access to the anonymous user,
/// you can return the object without using an authorization header.
///
///
///
/// An Amazon S3 bucket has no directory hierarchy such as you would find in a typical
/// computer file system. You can, however, create a logical hierarchy by using object
/// key names that imply a folder structure. For example, instead of naming an object
/// sample.jpg, you can name it photos/2006/February/sample.jpg.
///
///
///
/// To get an object from such a logical hierarchy, specify the full key name for the
/// object in the GET operation. For a virtual hosted-style request example,
/// if you have the object photos/2006/February/sample.jpg, specify the resource
/// as /photos/2006/February/sample.jpg. For a path-style request example,
/// if you have the object photos/2006/February/sample.jpg in the bucket
/// named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg.
/// For more information about request types, see HTTP
/// Host Header Bucket Specification.
///
///
///
/// For more information about returning the ACL of an object, see GetObjectAcl.
///
///
///
/// If the object you are retrieving is stored in the S3 Glacier 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 RestoreObject.
/// Otherwise, this action returns an InvalidObjectState error. For information
/// about restoring archived objects, see Restoring
/// Archived Objects.
///
///
///
/// Encryption request headers, like x-amz-server-side-encryption, should
/// not be sent for GET requests if your object uses server-side encryption with 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.
///
///
///
/// If you encrypt an object by using server-side encryption with customer-provided encryption
/// keys (SSE-C) when you store the object in Amazon S3, then when you GET the object,
/// you must use the following headers:
///
/// -
///
///
x-amz-server-side-encryption-customer-algorithm
///
/// -
///
///
x-amz-server-side-encryption-customer-key
///
/// -
///
///
x-amz-server-side-encryption-customer-key-MD5
///
///
///
/// For more information about SSE-C, see Server-Side
/// Encryption (Using Customer-Provided Encryption Keys).
///
///
///
/// Assuming you have the relevant permission to read object tags, the response also returns
/// the x-amz-tagging-count header that provides the count of number of tags
/// associated with the object. You can use GetObjectTagging
/// to retrieve the tag set associated with an object.
///
/// - Permissions
-
///
/// You need the relevant read object (or version) permission for this operation. For
/// more information, see Specifying
/// Permissions in a Policy. If the object that you request doesn’t exist, the error
/// that Amazon S3 returns depends on whether you also have the
s3:ListBucket
/// permission.
///
///
///
/// If you have the s3:ListBucket permission on the bucket, Amazon S3 returns
/// an HTTP status code 404 (Not Found) error.
///
///
///
/// If you don’t have the s3:ListBucket permission, Amazon S3 returns an
/// HTTP status code 403 ("access denied") error.
///
/// - Versioning
-
///
/// By default, the
GET action returns the current version of an object.
/// To return a different version, use the versionId subresource.
///
/// -
///
/// If you supply a
versionId, you need the s3:GetObjectVersion
/// permission to access a specific version of an object. If you request a specific version,
/// you do not need to have the s3:GetObject permission. If you request the
/// current version without a specific version ID, only s3:GetObject permission
/// is required. s3:GetObjectVersion permission won't be required.
///
/// -
///
/// If the current version of the object is a delete marker, Amazon S3 behaves as if the
/// object was deleted and includes
x-amz-delete-marker: true in the response.
///
///
///
/// For more information about versioning, see PutBucketVersioning.
///
///
/// - Overriding Response Header Values
-
///
/// There are times when you want to override certain response header values in a
GET
/// response. For example, you might override the Content-Disposition response
/// header value in your GET request.
///
///
///
/// You can override values for a set of response headers using the following query parameters.
/// These response header values are sent only on a successful request, that is, when
/// status code 200 OK is returned. The set of headers you can override using these parameters
/// is a subset of the headers that Amazon S3 accepts when you create an object. The response
/// headers that you can override for the GET response are Content-Type,
/// Content-Language, Expires, Cache-Control, Content-Disposition,
/// and Content-Encoding. To override these header values in the GET
/// response, you use the following request parameters.
///
///
///
/// 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.
///
/// -
///
///
response-content-type
///
/// -
///
///
response-content-language
///
/// -
///
///
response-expires
///
/// -
///
///
response-cache-control
///
/// -
///
///
response-content-disposition
///
/// -
///
///
response-content-encoding
///
///
- Overriding Response Header Values
-
///
/// If both of the
If-Match and If-Unmodified-Since headers
/// are present in the request as follows: If-Match condition evaluates to
/// true, and; If-Unmodified-Since condition evaluates to false;
/// then, S3 returns 200 OK and the data requested.
///
///
///
/// If both of the If-None-Match and If-Modified-Since headers
/// are present in the request as follows: If-None-Match condition evaluates
/// to false, and; If-Modified-Since condition evaluates to
/// true; then, S3 returns 304 Not Modified response code.
///
///
///
/// For more information about conditional requests, see RFC
/// 7232.
///
///
///
/// The following operations are related to GetObject:
///
///
///
/// Container for the necessary parameters to execute the GetObject service method.
///
/// The response from the GetObject service method, as returned by S3.
/// REST API Reference for GetObject Operation
public virtual GetObjectResponse GetObject(GetObjectRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetObjectRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetObjectResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Retrieves objects from Amazon S3. To use GET, you must have READ
/// access to the object. If you grant READ access to the anonymous user,
/// you can return the object without using an authorization header.
///
///
///
/// An Amazon S3 bucket has no directory hierarchy such as you would find in a typical
/// computer file system. You can, however, create a logical hierarchy by using object
/// key names that imply a folder structure. For example, instead of naming an object
/// sample.jpg, you can name it photos/2006/February/sample.jpg.
///
///
///
/// To get an object from such a logical hierarchy, specify the full key name for the
/// object in the GET operation. For a virtual hosted-style request example,
/// if you have the object photos/2006/February/sample.jpg, specify the resource
/// as /photos/2006/February/sample.jpg. For a path-style request example,
/// if you have the object photos/2006/February/sample.jpg in the bucket
/// named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg.
/// For more information about request types, see HTTP
/// Host Header Bucket Specification.
///
///
///
/// For more information about returning the ACL of an object, see GetObjectAcl.
///
///
///
/// If the object you are retrieving is stored in the S3 Glacier 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 RestoreObject.
/// Otherwise, this action returns an InvalidObjectState error. For information
/// about restoring archived objects, see Restoring
/// Archived Objects.
///
///
///
/// Encryption request headers, like x-amz-server-side-encryption, should
/// not be sent for GET requests if your object uses server-side encryption with 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.
///
///
///
/// If you encrypt an object by using server-side encryption with customer-provided encryption
/// keys (SSE-C) when you store the object in Amazon S3, then when you GET the object,
/// you must use the following headers:
///
/// -
///
///
x-amz-server-side-encryption-customer-algorithm
///
/// -
///
///
x-amz-server-side-encryption-customer-key
///
/// -
///
///
x-amz-server-side-encryption-customer-key-MD5
///
///
///
/// For more information about SSE-C, see Server-Side
/// Encryption (Using Customer-Provided Encryption Keys).
///
///
///
/// Assuming you have the relevant permission to read object tags, the response also returns
/// the x-amz-tagging-count header that provides the count of number of tags
/// associated with the object. You can use GetObjectTagging
/// to retrieve the tag set associated with an object.
///
/// - Permissions
-
///
/// You need the relevant read object (or version) permission for this operation. For
/// more information, see Specifying
/// Permissions in a Policy. If the object that you request doesn’t exist, the error
/// that Amazon S3 returns depends on whether you also have the
s3:ListBucket
/// permission.
///
///
///
/// If you have the s3:ListBucket permission on the bucket, Amazon S3 returns
/// an HTTP status code 404 (Not Found) error.
///
///
///
/// If you don’t have the s3:ListBucket permission, Amazon S3 returns an
/// HTTP status code 403 ("access denied") error.
///
/// - Versioning
-
///
/// By default, the
GET action returns the current version of an object.
/// To return a different version, use the versionId subresource.
///
/// -
///
/// If you supply a
versionId, you need the s3:GetObjectVersion
/// permission to access a specific version of an object. If you request a specific version,
/// you do not need to have the s3:GetObject permission. If you request the
/// current version without a specific version ID, only s3:GetObject permission
/// is required. s3:GetObjectVersion permission won't be required.
///
/// -
///
/// If the current version of the object is a delete marker, Amazon S3 behaves as if the
/// object was deleted and includes
x-amz-delete-marker: true in the response.
///
///
///
/// For more information about versioning, see PutBucketVersioning.
///
///
/// - Overriding Response Header Values
-
///
/// There are times when you want to override certain response header values in a
GET
/// response. For example, you might override the Content-Disposition response
/// header value in your GET request.
///
///
///
/// You can override values for a set of response headers using the following query parameters.
/// These response header values are sent only on a successful request, that is, when
/// status code 200 OK is returned. The set of headers you can override using these parameters
/// is a subset of the headers that Amazon S3 accepts when you create an object. The response
/// headers that you can override for the GET response are Content-Type,
/// Content-Language, Expires, Cache-Control, Content-Disposition,
/// and Content-Encoding. To override these header values in the GET
/// response, you use the following request parameters.
///
///
///
/// 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.
///
/// -
///
///
response-content-type
///
/// -
///
///
response-content-language
///
/// -
///
///
response-expires
///
/// -
///
///
response-cache-control
///
/// -
///
///
response-content-disposition
///
/// -
///
///
response-content-encoding
///
///
- Overriding Response Header Values
-
///
/// If both of the
If-Match and If-Unmodified-Since headers
/// are present in the request as follows: If-Match condition evaluates to
/// true, and; If-Unmodified-Since condition evaluates to false;
/// then, S3 returns 200 OK and the data requested.
///
///
///
/// If both of the If-None-Match and If-Modified-Since headers
/// are present in the request as follows: If-None-Match condition evaluates
/// to false, and; If-Modified-Since condition evaluates to
/// true; then, S3 returns 304 Not Modified response code.
///
///
///
/// For more information about conditional requests, see RFC
/// 7232.
///
///
///
/// The following operations are related to GetObject:
///
///
///
/// 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 AccessPointName-AccountId.s3-accesspoint.Region.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 Using access points in the Amazon S3 User Guide. When using an Object Lambda access point the hostname takes the form AccessPointName-AccountId.s3-object-lambda.Region.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 AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. 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 What is S3 on Outposts? in the Amazon S3 User Guide.
/// Key of the object to get.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetObject service method, as returned by S3.
/// REST API Reference for GetObject Operation
public virtual Task GetObjectAsync(string bucketName, string key, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var request = new GetObjectRequest();
request.BucketName = bucketName;
request.Key = key;
return GetObjectAsync(request, cancellationToken);
}
///
/// Retrieves objects from Amazon S3. To use GET, you must have READ
/// access to the object. If you grant READ access to the anonymous user,
/// you can return the object without using an authorization header.
///
///
///
/// An Amazon S3 bucket has no directory hierarchy such as you would find in a typical
/// computer file system. You can, however, create a logical hierarchy by using object
/// key names that imply a folder structure. For example, instead of naming an object
/// sample.jpg, you can name it photos/2006/February/sample.jpg.
///
///
///
/// To get an object from such a logical hierarchy, specify the full key name for the
/// object in the GET operation. For a virtual hosted-style request example,
/// if you have the object photos/2006/February/sample.jpg, specify the resource
/// as /photos/2006/February/sample.jpg. For a path-style request example,
/// if you have the object photos/2006/February/sample.jpg in the bucket
/// named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg.
/// For more information about request types, see HTTP
/// Host Header Bucket Specification.
///
///
///
/// For more information about returning the ACL of an object, see GetObjectAcl.
///
///
///
/// If the object you are retrieving is stored in the S3 Glacier 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 RestoreObject.
/// Otherwise, this action returns an InvalidObjectState error. For information
/// about restoring archived objects, see Restoring
/// Archived Objects.
///
///
///
/// Encryption request headers, like x-amz-server-side-encryption, should
/// not be sent for GET requests if your object uses server-side encryption with 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.
///
///
///
/// If you encrypt an object by using server-side encryption with customer-provided encryption
/// keys (SSE-C) when you store the object in Amazon S3, then when you GET the object,
/// you must use the following headers:
///
/// -
///
///
x-amz-server-side-encryption-customer-algorithm
///
/// -
///
///
x-amz-server-side-encryption-customer-key
///
/// -
///
///
x-amz-server-side-encryption-customer-key-MD5
///
///
///
/// For more information about SSE-C, see Server-Side
/// Encryption (Using Customer-Provided Encryption Keys).
///
///
///
/// Assuming you have the relevant permission to read object tags, the response also returns
/// the x-amz-tagging-count header that provides the count of number of tags
/// associated with the object. You can use GetObjectTagging
/// to retrieve the tag set associated with an object.
///
/// - Permissions
-
///
/// You need the relevant read object (or version) permission for this operation. For
/// more information, see Specifying
/// Permissions in a Policy. If the object that you request doesn’t exist, the error
/// that Amazon S3 returns depends on whether you also have the
s3:ListBucket
/// permission.
///
///
///
/// If you have the s3:ListBucket permission on the bucket, Amazon S3 returns
/// an HTTP status code 404 (Not Found) error.
///
///
///
/// If you don’t have the s3:ListBucket permission, Amazon S3 returns an
/// HTTP status code 403 ("access denied") error.
///
/// - Versioning
-
///
/// By default, the
GET action returns the current version of an object.
/// To return a different version, use the versionId subresource.
///
/// -
///
/// If you supply a
versionId, you need the s3:GetObjectVersion
/// permission to access a specific version of an object. If you request a specific version,
/// you do not need to have the s3:GetObject permission. If you request the
/// current version without a specific version ID, only s3:GetObject permission
/// is required. s3:GetObjectVersion permission won't be required.
///
/// -
///
/// If the current version of the object is a delete marker, Amazon S3 behaves as if the
/// object was deleted and includes
x-amz-delete-marker: true in the response.
///
///
///
/// For more information about versioning, see PutBucketVersioning.
///
///
/// - Overriding Response Header Values
-
///
/// There are times when you want to override certain response header values in a
GET
/// response. For example, you might override the Content-Disposition response
/// header value in your GET request.
///
///
///
/// You can override values for a set of response headers using the following query parameters.
/// These response header values are sent only on a successful request, that is, when
/// status code 200 OK is returned. The set of headers you can override using these parameters
/// is a subset of the headers that Amazon S3 accepts when you create an object. The response
/// headers that you can override for the GET response are Content-Type,
/// Content-Language, Expires, Cache-Control, Content-Disposition,
/// and Content-Encoding. To override these header values in the GET
/// response, you use the following request parameters.
///
///
///
/// 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.
///
/// -
///
///
response-content-type
///
/// -
///
///
response-content-language
///
/// -
///
///
response-expires
///
/// -
///
///
response-cache-control
///
/// -
///
///
response-content-disposition
///
/// -
///
///
response-content-encoding
///
///
- Overriding Response Header Values
-
///
/// If both of the
If-Match and If-Unmodified-Since headers
/// are present in the request as follows: If-Match condition evaluates to
/// true, and; If-Unmodified-Since condition evaluates to false;
/// then, S3 returns 200 OK and the data requested.
///
///
///
/// If both of the If-None-Match and If-Modified-Since headers
/// are present in the request as follows: If-None-Match condition evaluates
/// to false, and; If-Modified-Since condition evaluates to
/// true; then, S3 returns 304 Not Modified response code.
///
///
///
/// For more information about conditional requests, see RFC
/// 7232.
///
///
///
/// The following operations are related to GetObject:
///
///
///
/// 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 AccessPointName-AccountId.s3-accesspoint.Region.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 Using access points in the Amazon S3 User Guide. When using an Object Lambda access point the hostname takes the form AccessPointName-AccountId.s3-object-lambda.Region.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 AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. 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 What is S3 on Outposts? in the Amazon S3 User Guide.
/// Key of the object to get.
/// VersionId used to reference a specific version of the object.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetObject service method, as returned by S3.
/// REST API Reference for GetObject Operation
public virtual Task GetObjectAsync(string bucketName, string key, string versionId, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var request = new GetObjectRequest();
request.BucketName = bucketName;
request.Key = key;
request.VersionId = versionId;
return GetObjectAsync(request, cancellationToken);
}
///
/// Retrieves objects from Amazon S3. To use GET, you must have READ
/// access to the object. If you grant READ access to the anonymous user,
/// you can return the object without using an authorization header.
///
///
///
/// An Amazon S3 bucket has no directory hierarchy such as you would find in a typical
/// computer file system. You can, however, create a logical hierarchy by using object
/// key names that imply a folder structure. For example, instead of naming an object
/// sample.jpg, you can name it photos/2006/February/sample.jpg.
///
///
///
/// To get an object from such a logical hierarchy, specify the full key name for the
/// object in the GET operation. For a virtual hosted-style request example,
/// if you have the object photos/2006/February/sample.jpg, specify the resource
/// as /photos/2006/February/sample.jpg. For a path-style request example,
/// if you have the object photos/2006/February/sample.jpg in the bucket
/// named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg.
/// For more information about request types, see HTTP
/// Host Header Bucket Specification.
///
///
///
/// For more information about returning the ACL of an object, see GetObjectAcl.
///
///
///
/// If the object you are retrieving is stored in the S3 Glacier 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 RestoreObject.
/// Otherwise, this action returns an InvalidObjectState error. For information
/// about restoring archived objects, see Restoring
/// Archived Objects.
///
///
///
/// Encryption request headers, like x-amz-server-side-encryption, should
/// not be sent for GET requests if your object uses server-side encryption with 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.
///
///
///
/// If you encrypt an object by using server-side encryption with customer-provided encryption
/// keys (SSE-C) when you store the object in Amazon S3, then when you GET the object,
/// you must use the following headers:
///
/// -
///
///
x-amz-server-side-encryption-customer-algorithm
///
/// -
///
///
x-amz-server-side-encryption-customer-key
///
/// -
///
///
x-amz-server-side-encryption-customer-key-MD5
///
///
///
/// For more information about SSE-C, see Server-Side
/// Encryption (Using Customer-Provided Encryption Keys).
///
///
///
/// Assuming you have the relevant permission to read object tags, the response also returns
/// the x-amz-tagging-count header that provides the count of number of tags
/// associated with the object. You can use GetObjectTagging
/// to retrieve the tag set associated with an object.
///
/// - Permissions
-
///
/// You need the relevant read object (or version) permission for this operation. For
/// more information, see Specifying
/// Permissions in a Policy. If the object that you request doesn’t exist, the error
/// that Amazon S3 returns depends on whether you also have the
s3:ListBucket
/// permission.
///
///
///
/// If you have the s3:ListBucket permission on the bucket, Amazon S3 returns
/// an HTTP status code 404 (Not Found) error.
///
///
///
/// If you don’t have the s3:ListBucket permission, Amazon S3 returns an
/// HTTP status code 403 ("access denied") error.
///
/// - Versioning
-
///
/// By default, the
GET action returns the current version of an object.
/// To return a different version, use the versionId subresource.
///
/// -
///
/// If you supply a
versionId, you need the s3:GetObjectVersion
/// permission to access a specific version of an object. If you request a specific version,
/// you do not need to have the s3:GetObject permission. If you request the
/// current version without a specific version ID, only s3:GetObject permission
/// is required. s3:GetObjectVersion permission won't be required.
///
/// -
///
/// If the current version of the object is a delete marker, Amazon S3 behaves as if the
/// object was deleted and includes
x-amz-delete-marker: true in the response.
///
///
///
/// For more information about versioning, see PutBucketVersioning.
///
///
/// - Overriding Response Header Values
-
///
/// There are times when you want to override certain response header values in a
GET
/// response. For example, you might override the Content-Disposition response
/// header value in your GET request.
///
///
///
/// You can override values for a set of response headers using the following query parameters.
/// These response header values are sent only on a successful request, that is, when
/// status code 200 OK is returned. The set of headers you can override using these parameters
/// is a subset of the headers that Amazon S3 accepts when you create an object. The response
/// headers that you can override for the GET response are Content-Type,
/// Content-Language, Expires, Cache-Control, Content-Disposition,
/// and Content-Encoding. To override these header values in the GET
/// response, you use the following request parameters.
///
///
///
/// 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.
///
/// -
///
///
response-content-type
///
/// -
///
///
response-content-language
///
/// -
///
///
response-expires
///
/// -
///
///
response-cache-control
///
/// -
///
///
response-content-disposition
///
/// -
///
///
response-content-encoding
///
///
- Overriding Response Header Values
-
///
/// If both of the
If-Match and If-Unmodified-Since headers
/// are present in the request as follows: If-Match condition evaluates to
/// true, and; If-Unmodified-Since condition evaluates to false;
/// then, S3 returns 200 OK and the data requested.
///
///
///
/// If both of the If-None-Match and If-Modified-Since headers
/// are present in the request as follows: If-None-Match condition evaluates
/// to false, and; If-Modified-Since condition evaluates to
/// true; then, S3 returns 304 Not Modified response code.
///
///
///
/// For more information about conditional requests, see RFC
/// 7232.
///
///
///
/// The following operations are related to GetObject:
///
///
///
/// Container for the necessary parameters to execute the GetObject service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetObject service method, as returned by S3.
/// REST API Reference for GetObject Operation
public virtual Task GetObjectAsync(GetObjectRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = GetObjectRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetObjectResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region GetObjectAttributes
///
/// Retrieves all the metadata from an object without returning the object itself. This
/// action is useful if you're interested only in an object's metadata. To use GetObjectAttributes,
/// you must have READ access to the object.
///
///
///
/// GetObjectAttributes combines the functionality of HeadObject
/// and ListParts. All of the data returned with each of those individual
/// calls can be returned with a single call to GetObjectAttributes.
///
///
///
/// If you encrypt an object by using server-side encryption with customer-provided encryption
/// keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata
/// from the object, you must use the following headers:
///
/// -
///
///
x-amz-server-side-encryption-customer-algorithm
///
/// -
///
///
x-amz-server-side-encryption-customer-key
///
/// -
///
///
x-amz-server-side-encryption-customer-key-MD5
///
///
///
/// For more information about SSE-C, see Server-Side
/// Encryption (Using Customer-Provided Encryption Keys) in the Amazon S3 User
/// Guide.
///
/// -
///
/// Encryption request headers, such as
x-amz-server-side-encryption, should
/// not be sent for GET requests if your object uses server-side encryption with Amazon
/// Web Services KMS keys stored in Amazon Web Services Key Management Service (SSE-KMS)
/// or server-side encryption with Amazon S3 managed keys (SSE-S3). If your object does
/// use these types of keys, you'll get an HTTP 400 Bad Request error.
///
/// -
///
/// The last modified property in this case is the creation date of the object.
///
///
///
/// Consider the following when using request headers:
///
/// -
///
/// If both of the
If-Match and If-Unmodified-Since headers
/// are present in the request as follows, then Amazon S3 returns the HTTP status code
/// 200 OK and the data requested:
///
/// -
///
///
If-Match condition evaluates to true.
///
/// -
///
///
If-Unmodified-Since condition evaluates to false.
///
///
-
///
/// If both of the
If-None-Match and If-Modified-Since headers
/// are present in the request as follows, then Amazon S3 returns the HTTP status code
/// 304 Not Modified:
///
/// -
///
///
If-None-Match condition evaluates to false.
///
/// -
///
///
If-Modified-Since condition evaluates to true.
///
///
///
/// For more information about conditional requests, see RFC
/// 7232.
///
/// - Permissions
-
///
/// The permissions that you need to use this operation depend on whether the bucket is
/// versioned. If the bucket is versioned, you need both the
s3:GetObjectVersion
/// and s3:GetObjectVersionAttributes permissions for this operation. If
/// the bucket is not versioned, you need the s3:GetObject and s3:GetObjectAttributes
/// permissions. For more information, see Specifying
/// Permissions in a Policy in the Amazon S3 User Guide. If the object that
/// you request does not exist, the error Amazon S3 returns depends on whether you also
/// have the s3:ListBucket permission.
///
/// -
///
/// If you have the
s3:ListBucket permission on the bucket, Amazon S3 returns
/// an HTTP status code 404 Not Found ("no such key") error.
///
/// -
///
/// If you don't have the
s3:ListBucket permission, Amazon S3 returns an
/// HTTP status code 403 Forbidden ("access denied") error.
///
///
///
/// The following actions are related to GetObjectAttributes:
///
///
///
/// Container for the necessary parameters to execute the GetObjectAttributes service method.
///
/// The response from the GetObjectAttributes service method, as returned by S3.
/// REST API Reference for GetObjectAttributes Operation
public virtual GetObjectAttributesResponse GetObjectAttributes(GetObjectAttributesRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetObjectAttributesRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetObjectAttributesResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Retrieves all the metadata from an object without returning the object itself. This
/// action is useful if you're interested only in an object's metadata. To use GetObjectAttributes,
/// you must have READ access to the object.
///
///
///
/// GetObjectAttributes combines the functionality of HeadObject
/// and ListParts. All of the data returned with each of those individual
/// calls can be returned with a single call to GetObjectAttributes.
///
///
///
/// If you encrypt an object by using server-side encryption with customer-provided encryption
/// keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata
/// from the object, you must use the following headers:
///
/// -
///
///
x-amz-server-side-encryption-customer-algorithm
///
/// -
///
///
x-amz-server-side-encryption-customer-key
///
/// -
///
///
x-amz-server-side-encryption-customer-key-MD5
///
///
///
/// For more information about SSE-C, see Server-Side
/// Encryption (Using Customer-Provided Encryption Keys) in the Amazon S3 User
/// Guide.
///
/// -
///
/// Encryption request headers, such as
x-amz-server-side-encryption, should
/// not be sent for GET requests if your object uses server-side encryption with Amazon
/// Web Services KMS keys stored in Amazon Web Services Key Management Service (SSE-KMS)
/// or server-side encryption with Amazon S3 managed keys (SSE-S3). If your object does
/// use these types of keys, you'll get an HTTP 400 Bad Request error.
///
/// -
///
/// The last modified property in this case is the creation date of the object.
///
///
///
/// Consider the following when using request headers:
///
/// -
///
/// If both of the
If-Match and If-Unmodified-Since headers
/// are present in the request as follows, then Amazon S3 returns the HTTP status code
/// 200 OK and the data requested:
///
/// -
///
///
If-Match condition evaluates to true.
///
/// -
///
///
If-Unmodified-Since condition evaluates to false.
///
///
-
///
/// If both of the
If-None-Match and If-Modified-Since headers
/// are present in the request as follows, then Amazon S3 returns the HTTP status code
/// 304 Not Modified:
///
/// -
///
///
If-None-Match condition evaluates to false.
///
/// -
///
///
If-Modified-Since condition evaluates to true.
///
///
///
/// For more information about conditional requests, see RFC
/// 7232.
///
/// - Permissions
-
///
/// The permissions that you need to use this operation depend on whether the bucket is
/// versioned. If the bucket is versioned, you need both the
s3:GetObjectVersion
/// and s3:GetObjectVersionAttributes permissions for this operation. If
/// the bucket is not versioned, you need the s3:GetObject and s3:GetObjectAttributes
/// permissions. For more information, see Specifying
/// Permissions in a Policy in the Amazon S3 User Guide. If the object that
/// you request does not exist, the error Amazon S3 returns depends on whether you also
/// have the s3:ListBucket permission.
///
/// -
///
/// If you have the
s3:ListBucket permission on the bucket, Amazon S3 returns
/// an HTTP status code 404 Not Found ("no such key") error.
///
/// -
///
/// If you don't have the
s3:ListBucket permission, Amazon S3 returns an
/// HTTP status code 403 Forbidden ("access denied") error.
///
///
///
/// The following actions are related to GetObjectAttributes:
///
///
///
/// Container for the necessary parameters to execute the GetObjectAttributes service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetObjectAttributes service method, as returned by S3.
/// REST API Reference for GetObjectAttributes Operation
public virtual Task GetObjectAttributesAsync(GetObjectAttributesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = GetObjectAttributesRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetObjectAttributesResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region GetObjectLegalHold
///
/// Gets an object's current legal hold status. For more information, see Locking
/// Objects.
///
///
///
/// This action is not supported by Amazon S3 on Outposts.
///
///
///
/// The following action is related to GetObjectLegalHold:
///
///
///
/// Container for the necessary parameters to execute the GetObjectLegalHold service method.
///
/// The response from the GetObjectLegalHold service method, as returned by S3.
/// REST API Reference for GetObjectLegalHold Operation
public virtual GetObjectLegalHoldResponse GetObjectLegalHold(GetObjectLegalHoldRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetObjectLegalHoldRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetObjectLegalHoldResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Gets an object's current legal hold status. For more information, see Locking
/// Objects.
///
///
///
/// This action is not supported by Amazon S3 on Outposts.
///
///
///
/// The following action is related to GetObjectLegalHold:
///
///
///
/// Container for the necessary parameters to execute the GetObjectLegalHold service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetObjectLegalHold service method, as returned by S3.
/// REST API Reference for GetObjectLegalHold Operation
public virtual Task GetObjectLegalHoldAsync(GetObjectLegalHoldRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = GetObjectLegalHoldRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetObjectLegalHoldResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region GetObjectLockConfiguration
///
/// Gets the Object Lock configuration for a bucket. The rule specified in the Object
/// Lock configuration will be applied by default to every new object placed in the specified
/// bucket. For more information, see Locking
/// Objects.
///
///
///
/// The following action is related to GetObjectLockConfiguration:
///
///
///
/// Container for the necessary parameters to execute the GetObjectLockConfiguration service method.
///
/// The response from the GetObjectLockConfiguration service method, as returned by S3.
/// REST API Reference for GetObjectLockConfiguration Operation
public virtual GetObjectLockConfigurationResponse GetObjectLockConfiguration(GetObjectLockConfigurationRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetObjectLockConfigurationRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetObjectLockConfigurationResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Gets the Object Lock configuration for a bucket. The rule specified in the Object
/// Lock configuration will be applied by default to every new object placed in the specified
/// bucket. For more information, see Locking
/// Objects.
///
///
///
/// The following action is related to GetObjectLockConfiguration:
///
///
///
/// Container for the necessary parameters to execute the GetObjectLockConfiguration service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetObjectLockConfiguration service method, as returned by S3.
/// REST API Reference for GetObjectLockConfiguration Operation
public virtual Task GetObjectLockConfigurationAsync(GetObjectLockConfigurationRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = GetObjectLockConfigurationRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetObjectLockConfigurationResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region GetObjectMetadata
///
/// The HEAD action retrieves metadata from an object without returning the
/// object itself. This action is useful if you're only interested in an object's metadata.
/// To use HEAD, you must have READ access to the object.
///
///
///
/// A HEAD request has the same options as a GET action on an
/// object. The response is identical to the GET response except that there
/// is no response body. Because of this, if the HEAD request generates an
/// error, it returns a generic 400 Bad Request, 403 Forbidden
/// or 404 Not Found code. It is not possible to retrieve the exact exception
/// beyond these error codes.
///
///
///
/// If you encrypt an object by using server-side encryption with customer-provided encryption
/// keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata
/// from the object, you must use the following headers:
///
/// -
///
///
x-amz-server-side-encryption-customer-algorithm
///
/// -
///
///
x-amz-server-side-encryption-customer-key
///
/// -
///
///
x-amz-server-side-encryption-customer-key-MD5
///
///
///
/// For more information about SSE-C, see Server-Side
/// Encryption (Using Customer-Provided Encryption Keys).
///
/// -
///
/// Encryption request headers, like
x-amz-server-side-encryption, 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.
///
/// -
///
/// The last modified property in this case is the creation date of the object.
///
///
///
/// Request headers are limited to 8 KB in size. For more information, see Common
/// Request Headers.
///
///
///
/// Consider the following when using request headers:
///
/// -
///
/// Consideration 1 – If both of the
If-Match and If-Unmodified-Since
/// headers are present in the request as follows:
///
/// -
///
///
If-Match condition evaluates to true, and;
///
/// -
///
///
If-Unmodified-Since condition evaluates to false;
///
///
///
/// Then Amazon S3 returns 200 OK and the data requested.
///
/// -
///
/// Consideration 2 – If both of the
If-None-Match and If-Modified-Since
/// headers are present in the request as follows:
///
/// -
///
///
If-None-Match condition evaluates to false, and;
///
/// -
///
///
If-Modified-Since condition evaluates to true;
///
///
///
/// Then Amazon S3 returns the 304 Not Modified response code.
///
///
///
/// For more information about conditional requests, see RFC
/// 7232.
///
/// - Permissions
-
///
/// You need the relevant read object (or version) permission for this operation. For
/// more information, see Actions,
/// resources, and condition keys for Amazon S3. If the object you request doesn't
/// exist, the error that Amazon S3 returns depends on whether you also have the s3:ListBucket
/// permission.
///
///
-
///
/// If you have the
s3:ListBucket permission on the bucket, Amazon S3 returns
/// an HTTP status code 404 error.
///
/// -
///
/// If you don’t have the
s3:ListBucket permission, Amazon S3 returns an
/// HTTP status code 403 error.
///
///
///
/// The following actions are related to HeadObject:
///
///
///
/// 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 AccessPointName-AccountId.s3-accesspoint.Region.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 Using access points in the Amazon S3 User Guide. 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 AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. 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 What is S3 on Outposts? in the Amazon S3 User Guide.
/// The object key.
///
/// The response from the GetObjectMetadata service method, as returned by S3.
/// REST API Reference for GetObjectMetadata Operation
public virtual GetObjectMetadataResponse GetObjectMetadata(string bucketName, string key)
{
var request = new GetObjectMetadataRequest();
request.BucketName = bucketName;
request.Key = key;
return GetObjectMetadata(request);
}
///
/// The HEAD action retrieves metadata from an object without returning the
/// object itself. This action is useful if you're only interested in an object's metadata.
/// To use HEAD, you must have READ access to the object.
///
///
///
/// A HEAD request has the same options as a GET action on an
/// object. The response is identical to the GET response except that there
/// is no response body. Because of this, if the HEAD request generates an
/// error, it returns a generic 400 Bad Request, 403 Forbidden
/// or 404 Not Found code. It is not possible to retrieve the exact exception
/// beyond these error codes.
///
///
///
/// If you encrypt an object by using server-side encryption with customer-provided encryption
/// keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata
/// from the object, you must use the following headers:
///
/// -
///
///
x-amz-server-side-encryption-customer-algorithm
///
/// -
///
///
x-amz-server-side-encryption-customer-key
///
/// -
///
///
x-amz-server-side-encryption-customer-key-MD5
///
///
///
/// For more information about SSE-C, see Server-Side
/// Encryption (Using Customer-Provided Encryption Keys).
///
/// -
///
/// Encryption request headers, like
x-amz-server-side-encryption, 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.
///
/// -
///
/// The last modified property in this case is the creation date of the object.
///
///
///
/// Request headers are limited to 8 KB in size. For more information, see Common
/// Request Headers.
///
///
///
/// Consider the following when using request headers:
///
/// -
///
/// Consideration 1 – If both of the
If-Match and If-Unmodified-Since
/// headers are present in the request as follows:
///
/// -
///
///
If-Match condition evaluates to true, and;
///
/// -
///
///
If-Unmodified-Since condition evaluates to false;
///
///
///
/// Then Amazon S3 returns 200 OK and the data requested.
///
/// -
///
/// Consideration 2 – If both of the
If-None-Match and If-Modified-Since
/// headers are present in the request as follows:
///
/// -
///
///
If-None-Match condition evaluates to false, and;
///
/// -
///
///
If-Modified-Since condition evaluates to true;
///
///
///
/// Then Amazon S3 returns the 304 Not Modified response code.
///
///
///
/// For more information about conditional requests, see RFC
/// 7232.
///
/// - Permissions
-
///
/// You need the relevant read object (or version) permission for this operation. For
/// more information, see Actions,
/// resources, and condition keys for Amazon S3. If the object you request doesn't
/// exist, the error that Amazon S3 returns depends on whether you also have the s3:ListBucket
/// permission.
///
///
-
///
/// If you have the
s3:ListBucket permission on the bucket, Amazon S3 returns
/// an HTTP status code 404 error.
///
/// -
///
/// If you don’t have the
s3:ListBucket permission, Amazon S3 returns an
/// HTTP status code 403 error.
///
///
///
/// The following actions are related to HeadObject:
///
///
///
/// 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 AccessPointName-AccountId.s3-accesspoint.Region.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 Using access points in the Amazon S3 User Guide. 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 AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. 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 What is S3 on Outposts? in the Amazon S3 User Guide.
/// The object key.
/// VersionId used to reference a specific version of the object.
///
/// The response from the GetObjectMetadata service method, as returned by S3.
/// REST API Reference for GetObjectMetadata Operation
public virtual GetObjectMetadataResponse GetObjectMetadata(string bucketName, string key, string versionId)
{
var request = new GetObjectMetadataRequest();
request.BucketName = bucketName;
request.Key = key;
request.VersionId = versionId;
return GetObjectMetadata(request);
}
///
/// The HEAD action retrieves metadata from an object without returning the
/// object itself. This action is useful if you're only interested in an object's metadata.
/// To use HEAD, you must have READ access to the object.
///
///
///
/// A HEAD request has the same options as a GET action on an
/// object. The response is identical to the GET response except that there
/// is no response body. Because of this, if the HEAD request generates an
/// error, it returns a generic 400 Bad Request, 403 Forbidden
/// or 404 Not Found code. It is not possible to retrieve the exact exception
/// beyond these error codes.
///
///
///
/// If you encrypt an object by using server-side encryption with customer-provided encryption
/// keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata
/// from the object, you must use the following headers:
///
/// -
///
///
x-amz-server-side-encryption-customer-algorithm
///
/// -
///
///
x-amz-server-side-encryption-customer-key
///
/// -
///
///
x-amz-server-side-encryption-customer-key-MD5
///
///
///
/// For more information about SSE-C, see Server-Side
/// Encryption (Using Customer-Provided Encryption Keys).
///
/// -
///
/// Encryption request headers, like
x-amz-server-side-encryption, 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.
///
/// -
///
/// The last modified property in this case is the creation date of the object.
///
///
///
/// Request headers are limited to 8 KB in size. For more information, see Common
/// Request Headers.
///
///
///
/// Consider the following when using request headers:
///
/// -
///
/// Consideration 1 – If both of the
If-Match and If-Unmodified-Since
/// headers are present in the request as follows:
///
/// -
///
///
If-Match condition evaluates to true, and;
///
/// -
///
///
If-Unmodified-Since condition evaluates to false;
///
///
///
/// Then Amazon S3 returns 200 OK and the data requested.
///
/// -
///
/// Consideration 2 – If both of the
If-None-Match and If-Modified-Since
/// headers are present in the request as follows:
///
/// -
///
///
If-None-Match condition evaluates to false, and;
///
/// -
///
///
If-Modified-Since condition evaluates to true;
///
///
///
/// Then Amazon S3 returns the 304 Not Modified response code.
///
///
///
/// For more information about conditional requests, see RFC
/// 7232.
///
/// - Permissions
-
///
/// You need the relevant read object (or version) permission for this operation. For
/// more information, see Actions,
/// resources, and condition keys for Amazon S3. If the object you request doesn't
/// exist, the error that Amazon S3 returns depends on whether you also have the s3:ListBucket
/// permission.
///
///
-
///
/// If you have the
s3:ListBucket permission on the bucket, Amazon S3 returns
/// an HTTP status code 404 error.
///
/// -
///
/// If you don’t have the
s3:ListBucket permission, Amazon S3 returns an
/// HTTP status code 403 error.
///
///
///
/// The following actions are related to HeadObject:
///
///
///
/// Container for the necessary parameters to execute the GetObjectMetadata service method.
///
/// The response from the GetObjectMetadata service method, as returned by S3.
/// REST API Reference for GetObjectMetadata Operation
public virtual GetObjectMetadataResponse GetObjectMetadata(GetObjectMetadataRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetObjectMetadataRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetObjectMetadataResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// The HEAD action retrieves metadata from an object without returning the
/// object itself. This action is useful if you're only interested in an object's metadata.
/// To use HEAD, you must have READ access to the object.
///
///
///
/// A HEAD request has the same options as a GET action on an
/// object. The response is identical to the GET response except that there
/// is no response body. Because of this, if the HEAD request generates an
/// error, it returns a generic 400 Bad Request, 403 Forbidden
/// or 404 Not Found code. It is not possible to retrieve the exact exception
/// beyond these error codes.
///
///
///
/// If you encrypt an object by using server-side encryption with customer-provided encryption
/// keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata
/// from the object, you must use the following headers:
///
/// -
///
///
x-amz-server-side-encryption-customer-algorithm
///
/// -
///
///
x-amz-server-side-encryption-customer-key
///
/// -
///
///
x-amz-server-side-encryption-customer-key-MD5
///
///
///
/// For more information about SSE-C, see Server-Side
/// Encryption (Using Customer-Provided Encryption Keys).
///
/// -
///
/// Encryption request headers, like
x-amz-server-side-encryption, 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.
///
/// -
///
/// The last modified property in this case is the creation date of the object.
///
///
///
/// Request headers are limited to 8 KB in size. For more information, see Common
/// Request Headers.
///
///
///
/// Consider the following when using request headers:
///
/// -
///
/// Consideration 1 – If both of the
If-Match and If-Unmodified-Since
/// headers are present in the request as follows:
///
/// -
///
///
If-Match condition evaluates to true, and;
///
/// -
///
///
If-Unmodified-Since condition evaluates to false;
///
///
///
/// Then Amazon S3 returns 200 OK and the data requested.
///
/// -
///
/// Consideration 2 – If both of the
If-None-Match and If-Modified-Since
/// headers are present in the request as follows:
///
/// -
///
///
If-None-Match condition evaluates to false, and;
///
/// -
///
///
If-Modified-Since condition evaluates to true;
///
///
///
/// Then Amazon S3 returns the 304 Not Modified response code.
///
///
///
/// For more information about conditional requests, see RFC
/// 7232.
///
/// - Permissions
-
///
/// You need the relevant read object (or version) permission for this operation. For
/// more information, see Actions,
/// resources, and condition keys for Amazon S3. If the object you request doesn't
/// exist, the error that Amazon S3 returns depends on whether you also have the s3:ListBucket
/// permission.
///
///
-
///
/// If you have the
s3:ListBucket permission on the bucket, Amazon S3 returns
/// an HTTP status code 404 error.
///
/// -
///
/// If you don’t have the
s3:ListBucket permission, Amazon S3 returns an
/// HTTP status code 403 error.
///
///
///
/// The following actions are related to HeadObject:
///
///
///
/// 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 AccessPointName-AccountId.s3-accesspoint.Region.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 Using access points in the Amazon S3 User Guide. 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 AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. 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 What is S3 on Outposts? in the Amazon S3 User Guide.
/// The object key.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetObjectMetadata service method, as returned by S3.
/// REST API Reference for GetObjectMetadata Operation
public virtual Task GetObjectMetadataAsync(string bucketName, string key, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var request = new GetObjectMetadataRequest();
request.BucketName = bucketName;
request.Key = key;
return GetObjectMetadataAsync(request, cancellationToken);
}
///
/// The HEAD action retrieves metadata from an object without returning the
/// object itself. This action is useful if you're only interested in an object's metadata.
/// To use HEAD, you must have READ access to the object.
///
///
///
/// A HEAD request has the same options as a GET action on an
/// object. The response is identical to the GET response except that there
/// is no response body. Because of this, if the HEAD request generates an
/// error, it returns a generic 400 Bad Request, 403 Forbidden
/// or 404 Not Found code. It is not possible to retrieve the exact exception
/// beyond these error codes.
///
///
///
/// If you encrypt an object by using server-side encryption with customer-provided encryption
/// keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata
/// from the object, you must use the following headers:
///
/// -
///
///
x-amz-server-side-encryption-customer-algorithm
///
/// -
///
///
x-amz-server-side-encryption-customer-key
///
/// -
///
///
x-amz-server-side-encryption-customer-key-MD5
///
///
///
/// For more information about SSE-C, see Server-Side
/// Encryption (Using Customer-Provided Encryption Keys).
///
/// -
///
/// Encryption request headers, like
x-amz-server-side-encryption, 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.
///
/// -
///
/// The last modified property in this case is the creation date of the object.
///
///
///
/// Request headers are limited to 8 KB in size. For more information, see Common
/// Request Headers.
///
///
///
/// Consider the following when using request headers:
///
/// -
///
/// Consideration 1 – If both of the
If-Match and If-Unmodified-Since
/// headers are present in the request as follows:
///
/// -
///
///
If-Match condition evaluates to true, and;
///
/// -
///
///
If-Unmodified-Since condition evaluates to false;
///
///
///
/// Then Amazon S3 returns 200 OK and the data requested.
///
/// -
///
/// Consideration 2 – If both of the
If-None-Match and If-Modified-Since
/// headers are present in the request as follows:
///
/// -
///
///
If-None-Match condition evaluates to false, and;
///
/// -
///
///
If-Modified-Since condition evaluates to true;
///
///
///
/// Then Amazon S3 returns the 304 Not Modified response code.
///
///
///
/// For more information about conditional requests, see RFC
/// 7232.
///
/// - Permissions
-
///
/// You need the relevant read object (or version) permission for this operation. For
/// more information, see Actions,
/// resources, and condition keys for Amazon S3. If the object you request doesn't
/// exist, the error that Amazon S3 returns depends on whether you also have the s3:ListBucket
/// permission.
///
///
-
///
/// If you have the
s3:ListBucket permission on the bucket, Amazon S3 returns
/// an HTTP status code 404 error.
///
/// -
///
/// If you don’t have the
s3:ListBucket permission, Amazon S3 returns an
/// HTTP status code 403 error.
///
///
///
/// The following actions are related to HeadObject:
///
///
///
/// 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 AccessPointName-AccountId.s3-accesspoint.Region.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 Using access points in the Amazon S3 User Guide. 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 AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. 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 What is S3 on Outposts? in the Amazon S3 User Guide.
/// The object key.
/// VersionId used to reference a specific version of the object.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetObjectMetadata service method, as returned by S3.
/// REST API Reference for GetObjectMetadata Operation
public virtual Task GetObjectMetadataAsync(string bucketName, string key, string versionId, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var request = new GetObjectMetadataRequest();
request.BucketName = bucketName;
request.Key = key;
request.VersionId = versionId;
return GetObjectMetadataAsync(request, cancellationToken);
}
///
/// The HEAD action retrieves metadata from an object without returning the
/// object itself. This action is useful if you're only interested in an object's metadata.
/// To use HEAD, you must have READ access to the object.
///
///
///
/// A HEAD request has the same options as a GET action on an
/// object. The response is identical to the GET response except that there
/// is no response body. Because of this, if the HEAD request generates an
/// error, it returns a generic 400 Bad Request, 403 Forbidden
/// or 404 Not Found code. It is not possible to retrieve the exact exception
/// beyond these error codes.
///
///
///
/// If you encrypt an object by using server-side encryption with customer-provided encryption
/// keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata
/// from the object, you must use the following headers:
///
/// -
///
///
x-amz-server-side-encryption-customer-algorithm
///
/// -
///
///
x-amz-server-side-encryption-customer-key
///
/// -
///
///
x-amz-server-side-encryption-customer-key-MD5
///
///
///
/// For more information about SSE-C, see Server-Side
/// Encryption (Using Customer-Provided Encryption Keys).
///
/// -
///
/// Encryption request headers, like
x-amz-server-side-encryption, 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.
///
/// -
///
/// The last modified property in this case is the creation date of the object.
///
///
///
/// Request headers are limited to 8 KB in size. For more information, see Common
/// Request Headers.
///
///
///
/// Consider the following when using request headers:
///
/// -
///
/// Consideration 1 – If both of the
If-Match and If-Unmodified-Since
/// headers are present in the request as follows:
///
/// -
///
///
If-Match condition evaluates to true, and;
///
/// -
///
///
If-Unmodified-Since condition evaluates to false;
///
///
///
/// Then Amazon S3 returns 200 OK and the data requested.
///
/// -
///
/// Consideration 2 – If both of the
If-None-Match and If-Modified-Since
/// headers are present in the request as follows:
///
/// -
///
///
If-None-Match condition evaluates to false, and;
///
/// -
///
///
If-Modified-Since condition evaluates to true;
///
///
///
/// Then Amazon S3 returns the 304 Not Modified response code.
///
///
///
/// For more information about conditional requests, see RFC
/// 7232.
///
/// - Permissions
-
///
/// You need the relevant read object (or version) permission for this operation. For
/// more information, see Actions,
/// resources, and condition keys for Amazon S3. If the object you request doesn't
/// exist, the error that Amazon S3 returns depends on whether you also have the s3:ListBucket
/// permission.
///
///
-
///
/// If you have the
s3:ListBucket permission on the bucket, Amazon S3 returns
/// an HTTP status code 404 error.
///
/// -
///
/// If you don’t have the
s3:ListBucket permission, Amazon S3 returns an
/// HTTP status code 403 error.
///
///
///
/// The following actions are related to HeadObject:
///
///
///
/// Container for the necessary parameters to execute the GetObjectMetadata service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetObjectMetadata service method, as returned by S3.
/// REST API Reference for GetObjectMetadata Operation
public virtual Task GetObjectMetadataAsync(GetObjectMetadataRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = GetObjectMetadataRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetObjectMetadataResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region GetObjectRetention
///
/// Retrieves an object's retention settings. For more information, see Locking
/// Objects.
///
///
///
/// This action is not supported by Amazon S3 on Outposts.
///
///
///
/// The following action is related to GetObjectRetention:
///
///
///
/// Container for the necessary parameters to execute the GetObjectRetention service method.
///
/// The response from the GetObjectRetention service method, as returned by S3.
/// REST API Reference for GetObjectRetention Operation
public virtual GetObjectRetentionResponse GetObjectRetention(GetObjectRetentionRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetObjectRetentionRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetObjectRetentionResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Retrieves an object's retention settings. For more information, see Locking
/// Objects.
///
///
///
/// This action is not supported by Amazon S3 on Outposts.
///
///
///
/// The following action is related to GetObjectRetention:
///
///
///
/// Container for the necessary parameters to execute the GetObjectRetention service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetObjectRetention service method, as returned by S3.
/// REST API Reference for GetObjectRetention Operation
public virtual Task GetObjectRetentionAsync(GetObjectRetentionRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = GetObjectRetentionRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetObjectRetentionResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region GetObjectTagging
///
/// Returns the tag-set of an object. You send the GET request against the tagging subresource
/// associated with the object.
///
///
///
/// To use this operation, you must have permission to perform the s3:GetObjectTagging
/// action. By default, the GET action returns information about current version of an
/// object. For a versioned bucket, you can have multiple versions of an object in your
/// bucket. To retrieve tags of any other version, use the versionId query parameter.
/// You also need permission for the s3:GetObjectVersionTagging action.
///
///
///
/// By default, the bucket owner has this permission and can grant this permission to
/// others.
///
///
///
/// For information about the Amazon S3 object tagging feature, see Object
/// Tagging.
///
///
///
/// The following actions are related to GetObjectTagging:
///
///
///
/// Container for the necessary parameters to execute the GetObjectTagging service method.
///
/// The response from the GetObjectTagging service method, as returned by S3.
/// REST API Reference for GetObjectTagging Operation
public virtual GetObjectTaggingResponse GetObjectTagging(GetObjectTaggingRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetObjectTaggingRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetObjectTaggingResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Returns the tag-set of an object. You send the GET request against the tagging subresource
/// associated with the object.
///
///
///
/// To use this operation, you must have permission to perform the s3:GetObjectTagging
/// action. By default, the GET action returns information about current version of an
/// object. For a versioned bucket, you can have multiple versions of an object in your
/// bucket. To retrieve tags of any other version, use the versionId query parameter.
/// You also need permission for the s3:GetObjectVersionTagging action.
///
///
///
/// By default, the bucket owner has this permission and can grant this permission to
/// others.
///
///
///
/// For information about the Amazon S3 object tagging feature, see Object
/// Tagging.
///
///
///
/// The following actions are related to GetObjectTagging:
///
///
///
/// Container for the necessary parameters to execute the GetObjectTagging service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetObjectTagging service method, as returned by S3.
/// REST API Reference for GetObjectTagging Operation
public virtual Task GetObjectTaggingAsync(GetObjectTaggingRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = GetObjectTaggingRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetObjectTaggingResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region GetObjectTorrent
///
/// Returns torrent files from a bucket. BitTorrent can save you bandwidth when you're
/// distributing large files.
///
///
///
/// You can get torrent only for objects that are less than 5 GB in size, and that are
/// not encrypted using server-side encryption with a customer-provided encryption key.
///
///
///
/// To use GET, you must have READ access to the object.
///
///
///
/// This action is not supported by Amazon S3 on Outposts.
///
///
///
/// The following action is related to GetObjectTorrent:
///
///
///
/// The name of the bucket containing the object for which to get the torrent files.
/// The object key for which to get the information.
///
/// The response from the GetObjectTorrent service method, as returned by S3.
/// REST API Reference for GetObjectTorrent Operation
public virtual GetObjectTorrentResponse GetObjectTorrent(string bucketName, string key)
{
var request = new GetObjectTorrentRequest();
request.BucketName = bucketName;
request.Key = key;
return GetObjectTorrent(request);
}
///
/// Returns torrent files from a bucket. BitTorrent can save you bandwidth when you're
/// distributing large files.
///
///
///
/// You can get torrent only for objects that are less than 5 GB in size, and that are
/// not encrypted using server-side encryption with a customer-provided encryption key.
///
///
///
/// To use GET, you must have READ access to the object.
///
///
///
/// This action is not supported by Amazon S3 on Outposts.
///
///
///
/// The following action is related to GetObjectTorrent:
///
///
///
/// Container for the necessary parameters to execute the GetObjectTorrent service method.
///
/// The response from the GetObjectTorrent service method, as returned by S3.
/// REST API Reference for GetObjectTorrent Operation
public virtual GetObjectTorrentResponse GetObjectTorrent(GetObjectTorrentRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetObjectTorrentRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetObjectTorrentResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Returns torrent files from a bucket. BitTorrent can save you bandwidth when you're
/// distributing large files.
///
///
///
/// You can get torrent only for objects that are less than 5 GB in size, and that are
/// not encrypted using server-side encryption with a customer-provided encryption key.
///
///
///
/// To use GET, you must have READ access to the object.
///
///
///
/// This action is not supported by Amazon S3 on Outposts.
///
///
///
/// The following action is related to GetObjectTorrent:
///
///
///
/// The name of the bucket containing the object for which to get the torrent files.
/// The object key for which to get the information.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetObjectTorrent service method, as returned by S3.
/// REST API Reference for GetObjectTorrent Operation
public virtual Task GetObjectTorrentAsync(string bucketName, string key, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var request = new GetObjectTorrentRequest();
request.BucketName = bucketName;
request.Key = key;
return GetObjectTorrentAsync(request, cancellationToken);
}
///
/// Returns torrent files from a bucket. BitTorrent can save you bandwidth when you're
/// distributing large files.
///
///
///
/// You can get torrent only for objects that are less than 5 GB in size, and that are
/// not encrypted using server-side encryption with a customer-provided encryption key.
///
///
///
/// To use GET, you must have READ access to the object.
///
///
///
/// This action is not supported by Amazon S3 on Outposts.
///
///
///
/// The following action is related to GetObjectTorrent:
///
///
///
/// Container for the necessary parameters to execute the GetObjectTorrent service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetObjectTorrent service method, as returned by S3.
/// REST API Reference for GetObjectTorrent Operation
public virtual Task GetObjectTorrentAsync(GetObjectTorrentRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = GetObjectTorrentRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetObjectTorrentResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region GetPublicAccessBlock
///
/// Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket.
/// To use this operation, you must have the s3:GetBucketPublicAccessBlock
/// permission. For more information about Amazon S3 permissions, see Specifying
/// Permissions in a Policy.
///
///
///
/// When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket
/// or an object, it checks the PublicAccessBlock configuration for both
/// the bucket (or the bucket that contains the object) and the bucket owner's account.
/// If the PublicAccessBlock settings are different between the bucket and
/// the account, Amazon S3 uses the most restrictive combination of the bucket-level and
/// account-level settings.
///
///
///
/// For more information about when Amazon S3 considers a bucket or an object public,
/// see The
/// Meaning of "Public".
///
///
///
/// The following operations are related to GetPublicAccessBlock:
///
///
///
/// Container for the necessary parameters to execute the GetPublicAccessBlock service method.
///
/// The response from the GetPublicAccessBlock service method, as returned by S3.
/// REST API Reference for GetPublicAccessBlock Operation
public virtual GetPublicAccessBlockResponse GetPublicAccessBlock(GetPublicAccessBlockRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetPublicAccessBlockRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetPublicAccessBlockResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket.
/// To use this operation, you must have the s3:GetBucketPublicAccessBlock
/// permission. For more information about Amazon S3 permissions, see Specifying
/// Permissions in a Policy.
///
///
///
/// When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket
/// or an object, it checks the PublicAccessBlock configuration for both
/// the bucket (or the bucket that contains the object) and the bucket owner's account.
/// If the PublicAccessBlock settings are different between the bucket and
/// the account, Amazon S3 uses the most restrictive combination of the bucket-level and
/// account-level settings.
///
///
///
/// For more information about when Amazon S3 considers a bucket or an object public,
/// see The
/// Meaning of "Public".
///
///
///
/// The following operations are related to GetPublicAccessBlock:
///
///
///
/// Container for the necessary parameters to execute the GetPublicAccessBlock service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetPublicAccessBlock service method, as returned by S3.
/// REST API Reference for GetPublicAccessBlock Operation
public virtual Task GetPublicAccessBlockAsync(GetPublicAccessBlockRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = GetPublicAccessBlockRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetPublicAccessBlockResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region HeadBucket
///
/// This action is useful to determine if a bucket exists and you have permission to access
/// it. The action returns a 200 OK if the bucket exists and you have permission
/// to access it.
///
///
///
/// If the bucket does not exist or you do not have permission to access it, the HEAD
/// request returns a generic 400 Bad Request, 403 Forbidden
/// or 404 Not Found code. A message body is not included, so you cannot
/// determine the exception beyond these error codes.
///
///
///
/// To use this operation, you must have permissions to perform the s3:ListBucket
/// action. The bucket owner has this permission by default and can grant this permission
/// to others. For more information about permissions, see Permissions
/// Related to Bucket Subresource Operations and Managing
/// Access Permissions to Your Amazon S3 Resources.
///
///
///
/// To use this API operation against an access point, you must provide the alias of the
/// access point in place of the bucket name or specify the access point ARN. When using
/// the access point ARN, you must direct requests to the access point hostname. The access
/// point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com.
/// When using the Amazon Web Services SDKs, you provide the ARN in place of the bucket
/// name. For more information, see Using
/// access points.
///
///
///
/// 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 InvalidAccessPointAliasError
/// is returned. For more information about InvalidAccessPointAliasError,
/// see List
/// of Error Codes.
///
///
/// Container for the necessary parameters to execute the HeadBucket service method.
///
/// The response from the HeadBucket service method, as returned by S3.
/// REST API Reference for HeadBucket Operation
internal virtual HeadBucketResponse HeadBucket(HeadBucketRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = HeadBucketRequestMarshaller.Instance;
options.ResponseUnmarshaller = HeadBucketResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// This action is useful to determine if a bucket exists and you have permission to access
/// it. The action returns a 200 OK if the bucket exists and you have permission
/// to access it.
///
///
///
/// If the bucket does not exist or you do not have permission to access it, the HEAD
/// request returns a generic 400 Bad Request, 403 Forbidden
/// or 404 Not Found code. A message body is not included, so you cannot
/// determine the exception beyond these error codes.
///
///
///
/// To use this operation, you must have permissions to perform the s3:ListBucket
/// action. The bucket owner has this permission by default and can grant this permission
/// to others. For more information about permissions, see Permissions
/// Related to Bucket Subresource Operations and Managing
/// Access Permissions to Your Amazon S3 Resources.
///
///
///
/// To use this API operation against an access point, you must provide the alias of the
/// access point in place of the bucket name or specify the access point ARN. When using
/// the access point ARN, you must direct requests to the access point hostname. The access
/// point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com.
/// When using the Amazon Web Services SDKs, you provide the ARN in place of the bucket
/// name. For more information, see Using
/// access points.
///
///
///
/// 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 InvalidAccessPointAliasError
/// is returned. For more information about InvalidAccessPointAliasError,
/// see List
/// of Error Codes.
///
///
/// Container for the necessary parameters to execute the HeadBucket service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the HeadBucket service method, as returned by S3.
/// REST API Reference for HeadBucket Operation
internal virtual Task HeadBucketAsync(HeadBucketRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = HeadBucketRequestMarshaller.Instance;
options.ResponseUnmarshaller = HeadBucketResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region InitiateMultipartUpload
///
/// This action initiates a multipart upload and returns an upload ID. This upload ID
/// is used to associate all of the parts in the specific multipart upload. You specify
/// this upload ID in each of your subsequent upload part requests (see UploadPart).
/// You also include this upload ID in the final request to either complete or abort the
/// multipart upload request.
///
///
///
/// For more information about multipart uploads, see Multipart
/// Upload Overview.
///
///
///
/// If you have configured a lifecycle rule to abort incomplete multipart uploads, the
/// upload must complete within the number of days specified in the bucket lifecycle configuration.
/// Otherwise, the incomplete multipart upload becomes eligible for an abort action and
/// Amazon S3 aborts the multipart upload. For more information, see Aborting
/// Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration.
///
///
///
/// For information about the permissions required to use the multipart upload API, see
/// Multipart
/// Upload and Permissions.
///
///
///
/// For request signing, multipart upload is just a series of regular requests. You initiate
/// a multipart upload, send one or more requests to upload parts, and then complete the
/// multipart upload process. You sign each request individually. There is nothing special
/// about signing multipart upload requests. For more information about signing, see Authenticating
/// Requests (Amazon Web Services Signature Version 4).
///
///
///
/// 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.
///
///
///
/// 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 UploadPart
/// and UploadPartCopy
/// requests must match the headers you used in the request to initiate the upload by
/// using CreateMultipartUpload. 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).
///
///
///
/// To perform a multipart upload with encryption by using an Amazon Web Services KMS
/// key, the requester must have permission to the kms:Decrypt and kms:GenerateDataKey*
/// actions on the key. These permissions are required because Amazon S3 must decrypt
/// and read data from the encrypted file parts before it completes the multipart upload.
/// For more information, see Multipart
/// upload API and permissions and Protecting
/// data using server-side encryption with Amazon Web Services KMS in the Amazon
/// S3 User Guide.
///
///
///
/// If your Identity and Access Management (IAM) user or role is in the same Amazon Web
/// Services account as the KMS key, then you must have these permissions on the key policy.
/// If your IAM user or role belongs to a different account than the key, then you must
/// have the permissions on both the key policy and your IAM user or role.
///
///
///
/// For more information, see Protecting
/// Data Using Server-Side Encryption.
///
/// - Access Permissions
-
///
/// When copying an object, you can optionally specify the accounts or groups that should
/// be granted specific permissions on the new object. There are two ways to grant the
/// permissions using the request headers:
///
///
-
///
/// Specify a canned ACL with the
x-amz-acl request header. For more information,
/// see Canned
/// ACL.
///
/// -
///
/// Specify access permissions explicitly with the
x-amz-grant-read, x-amz-grant-read-acp,
/// x-amz-grant-write-acp, and x-amz-grant-full-control headers.
/// These parameters map to the set of permissions that Amazon S3 supports in an ACL.
/// For more information, see Access
/// Control List (ACL) Overview.
///
///
///
/// You can use either a canned ACL or specify access permissions explicitly. You cannot
/// do both.
///
/// - Server-Side- Encryption-Specific Request Headers
-
///
/// 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).
///
///
-
///
/// Use KMS keys (SSE-KMS) that include the Amazon Web Services managed key (
aws/s3)
/// 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.
///
/// -
///
///
x-amz-server-side-encryption
///
/// -
///
///
x-amz-server-side-encryption-aws-kms-key-id
///
/// -
///
///
x-amz-server-side-encryption-context
///
///
///
/// If you specify x-amz-server-side-encryption:aws:kms, but don't provide
/// x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the Amazon
/// Web Services managed key (aws/s3 key) in KMS to protect the data.
///
///
///
/// All GET and PUT 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.
///
///
///
/// For more information about server-side encryption with KMS keys (SSE-KMS), see Protecting
/// Data Using Server-Side Encryption with KMS keys.
///
/// -
///
/// Use customer-provided encryption keys (SSE-C) – If you want to manage your own encryption
/// keys, provide all the following headers in the request.
///
///
-
///
///
x-amz-server-side-encryption-customer-algorithm
///
/// -
///
///
x-amz-server-side-encryption-customer-key
///
/// -
///
///
x-amz-server-side-encryption-customer-key-MD5
///
///
///
/// For more information about server-side encryption with customer-provided encryption
/// keys (SSE-C), see
/// Protecting data using server-side encryption with customer-provided encryption keys
/// (SSE-C).
///
///
- Access-Control-List (ACL)-Specific Request Headers
-
///
///
/// You also can use the following access control–related headers with this operation.
/// By default, all objects are private. Only the owner has full access control. When
/// adding a new object, you can grant permissions to individual Amazon Web Services accounts
/// or to predefined groups defined by Amazon S3. These permissions are then added to
/// the access control list (ACL) on the object. For more information, see Using
/// ACLs. With this operation, you can grant access permissions using one of the following
/// two methods:
///
///
-
///
/// Specify a canned ACL (
x-amz-acl) — Amazon S3 supports a set of predefined
/// ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees
/// and permissions. For more information, see Canned
/// ACL.
///
/// -
///
/// Specify access permissions explicitly — To explicitly grant access permissions to
/// specific Amazon Web Services accounts or groups, use the following headers. Each header
/// maps to specific permissions that Amazon S3 supports in an ACL. For more information,
/// see Access
/// Control List (ACL) Overview. In the header, you specify a list of grantees who
/// get the specific permission. To grant permissions explicitly, use:
///
///
-
///
///
x-amz-grant-read
///
/// -
///
///
x-amz-grant-write
///
/// -
///
///
x-amz-grant-read-acp
///
/// -
///
///
x-amz-grant-write-acp
///
/// -
///
///
x-amz-grant-full-control
///
///
///
/// You specify each grantee as a type=value pair, where the type is one of the following:
///
/// -
///
///
id – if the value specified is the canonical user ID of an Amazon Web
/// Services account
///
/// -
///
///
uri – if you are granting permissions to a predefined group
///
/// -
///
///
emailAddress – if the value specified is the email address of an Amazon
/// Web Services account
///
///
///
/// Using email addresses to specify a grantee is only supported in the following Amazon
/// Web Services Regions:
///
/// -
///
/// US East (N. Virginia)
///
///
-
///
/// US West (N. California)
///
///
-
///
/// US West (Oregon)
///
///
-
///
/// Asia Pacific (Singapore)
///
///
-
///
/// Asia Pacific (Sydney)
///
///
-
///
/// Asia Pacific (Tokyo)
///
///
-
///
/// Europe (Ireland)
///
///
-
///
/// South America (São Paulo)
///
///
///
/// For a list of all the Amazon S3 supported Regions and endpoints, see Regions
/// and Endpoints in the Amazon Web Services General Reference.
///
///
///
/// For example, the following x-amz-grant-read header grants the Amazon
/// Web Services accounts identified by account IDs permissions to read object data and
/// its metadata:
///
///
///
/// x-amz-grant-read: id="11112222333", id="444455556666"
///
///
///
/// The following operations are related to CreateMultipartUpload:
///
///
///
/// 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 AccessPointName-AccountId.s3-accesspoint.Region.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 Using access points in the Amazon S3 User Guide. 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 AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. 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 What is S3 on Outposts? in the Amazon S3 User Guide.
/// Object key for which the multipart upload is to be initiated.
///
/// The response from the InitiateMultipartUpload service method, as returned by S3.
/// REST API Reference for InitiateMultipartUpload Operation
public virtual InitiateMultipartUploadResponse InitiateMultipartUpload(string bucketName, string key)
{
var request = new InitiateMultipartUploadRequest();
request.BucketName = bucketName;
request.Key = key;
return InitiateMultipartUpload(request);
}
///
/// This action initiates a multipart upload and returns an upload ID. This upload ID
/// is used to associate all of the parts in the specific multipart upload. You specify
/// this upload ID in each of your subsequent upload part requests (see UploadPart).
/// You also include this upload ID in the final request to either complete or abort the
/// multipart upload request.
///
///
///
/// For more information about multipart uploads, see Multipart
/// Upload Overview.
///
///
///
/// If you have configured a lifecycle rule to abort incomplete multipart uploads, the
/// upload must complete within the number of days specified in the bucket lifecycle configuration.
/// Otherwise, the incomplete multipart upload becomes eligible for an abort action and
/// Amazon S3 aborts the multipart upload. For more information, see Aborting
/// Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration.
///
///
///
/// For information about the permissions required to use the multipart upload API, see
/// Multipart
/// Upload and Permissions.
///
///
///
/// For request signing, multipart upload is just a series of regular requests. You initiate
/// a multipart upload, send one or more requests to upload parts, and then complete the
/// multipart upload process. You sign each request individually. There is nothing special
/// about signing multipart upload requests. For more information about signing, see Authenticating
/// Requests (Amazon Web Services Signature Version 4).
///
///
///
/// 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.
///
///
///
/// 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 UploadPart
/// and UploadPartCopy
/// requests must match the headers you used in the request to initiate the upload by
/// using CreateMultipartUpload. 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).
///
///
///
/// To perform a multipart upload with encryption by using an Amazon Web Services KMS
/// key, the requester must have permission to the kms:Decrypt and kms:GenerateDataKey*
/// actions on the key. These permissions are required because Amazon S3 must decrypt
/// and read data from the encrypted file parts before it completes the multipart upload.
/// For more information, see Multipart
/// upload API and permissions and Protecting
/// data using server-side encryption with Amazon Web Services KMS in the Amazon
/// S3 User Guide.
///
///
///
/// If your Identity and Access Management (IAM) user or role is in the same Amazon Web
/// Services account as the KMS key, then you must have these permissions on the key policy.
/// If your IAM user or role belongs to a different account than the key, then you must
/// have the permissions on both the key policy and your IAM user or role.
///
///
///
/// For more information, see Protecting
/// Data Using Server-Side Encryption.
///
/// - Access Permissions
-
///
/// When copying an object, you can optionally specify the accounts or groups that should
/// be granted specific permissions on the new object. There are two ways to grant the
/// permissions using the request headers:
///
///
-
///
/// Specify a canned ACL with the
x-amz-acl request header. For more information,
/// see Canned
/// ACL.
///
/// -
///
/// Specify access permissions explicitly with the
x-amz-grant-read, x-amz-grant-read-acp,
/// x-amz-grant-write-acp, and x-amz-grant-full-control headers.
/// These parameters map to the set of permissions that Amazon S3 supports in an ACL.
/// For more information, see Access
/// Control List (ACL) Overview.
///
///
///
/// You can use either a canned ACL or specify access permissions explicitly. You cannot
/// do both.
///
/// - Server-Side- Encryption-Specific Request Headers
-
///
/// 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).
///
///
-
///
/// Use KMS keys (SSE-KMS) that include the Amazon Web Services managed key (
aws/s3)
/// 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.
///
/// -
///
///
x-amz-server-side-encryption
///
/// -
///
///
x-amz-server-side-encryption-aws-kms-key-id
///
/// -
///
///
x-amz-server-side-encryption-context
///
///
///
/// If you specify x-amz-server-side-encryption:aws:kms, but don't provide
/// x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the Amazon
/// Web Services managed key (aws/s3 key) in KMS to protect the data.
///
///
///
/// All GET and PUT 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.
///
///
///
/// For more information about server-side encryption with KMS keys (SSE-KMS), see Protecting
/// Data Using Server-Side Encryption with KMS keys.
///
/// -
///
/// Use customer-provided encryption keys (SSE-C) – If you want to manage your own encryption
/// keys, provide all the following headers in the request.
///
///
-
///
///
x-amz-server-side-encryption-customer-algorithm
///
/// -
///
///
x-amz-server-side-encryption-customer-key
///
/// -
///
///
x-amz-server-side-encryption-customer-key-MD5
///
///
///
/// For more information about server-side encryption with customer-provided encryption
/// keys (SSE-C), see
/// Protecting data using server-side encryption with customer-provided encryption keys
/// (SSE-C).
///
///
- Access-Control-List (ACL)-Specific Request Headers
-
///
///
/// You also can use the following access control–related headers with this operation.
/// By default, all objects are private. Only the owner has full access control. When
/// adding a new object, you can grant permissions to individual Amazon Web Services accounts
/// or to predefined groups defined by Amazon S3. These permissions are then added to
/// the access control list (ACL) on the object. For more information, see Using
/// ACLs. With this operation, you can grant access permissions using one of the following
/// two methods:
///
///
-
///
/// Specify a canned ACL (
x-amz-acl) — Amazon S3 supports a set of predefined
/// ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees
/// and permissions. For more information, see Canned
/// ACL.
///
/// -
///
/// Specify access permissions explicitly — To explicitly grant access permissions to
/// specific Amazon Web Services accounts or groups, use the following headers. Each header
/// maps to specific permissions that Amazon S3 supports in an ACL. For more information,
/// see Access
/// Control List (ACL) Overview. In the header, you specify a list of grantees who
/// get the specific permission. To grant permissions explicitly, use:
///
///
-
///
///
x-amz-grant-read
///
/// -
///
///
x-amz-grant-write
///
/// -
///
///
x-amz-grant-read-acp
///
/// -
///
///
x-amz-grant-write-acp
///
/// -
///
///
x-amz-grant-full-control
///
///
///
/// You specify each grantee as a type=value pair, where the type is one of the following:
///
/// -
///
///
id – if the value specified is the canonical user ID of an Amazon Web
/// Services account
///
/// -
///
///
uri – if you are granting permissions to a predefined group
///
/// -
///
///
emailAddress – if the value specified is the email address of an Amazon
/// Web Services account
///
///
///
/// Using email addresses to specify a grantee is only supported in the following Amazon
/// Web Services Regions:
///
/// -
///
/// US East (N. Virginia)
///
///
-
///
/// US West (N. California)
///
///
-
///
/// US West (Oregon)
///
///
-
///
/// Asia Pacific (Singapore)
///
///
-
///
/// Asia Pacific (Sydney)
///
///
-
///
/// Asia Pacific (Tokyo)
///
///
-
///
/// Europe (Ireland)
///
///
-
///
/// South America (São Paulo)
///
///
///
/// For a list of all the Amazon S3 supported Regions and endpoints, see Regions
/// and Endpoints in the Amazon Web Services General Reference.
///
///
///
/// For example, the following x-amz-grant-read header grants the Amazon
/// Web Services accounts identified by account IDs permissions to read object data and
/// its metadata:
///
///
///
/// x-amz-grant-read: id="11112222333", id="444455556666"
///
///
///
/// The following operations are related to CreateMultipartUpload:
///
///
///
/// Container for the necessary parameters to execute the InitiateMultipartUpload service method.
///
/// The response from the InitiateMultipartUpload service method, as returned by S3.
/// REST API Reference for InitiateMultipartUpload Operation
public virtual InitiateMultipartUploadResponse InitiateMultipartUpload(InitiateMultipartUploadRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = InitiateMultipartUploadRequestMarshaller.Instance;
options.ResponseUnmarshaller = InitiateMultipartUploadResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// This action initiates a multipart upload and returns an upload ID. This upload ID
/// is used to associate all of the parts in the specific multipart upload. You specify
/// this upload ID in each of your subsequent upload part requests (see UploadPart).
/// You also include this upload ID in the final request to either complete or abort the
/// multipart upload request.
///
///
///
/// For more information about multipart uploads, see Multipart
/// Upload Overview.
///
///
///
/// If you have configured a lifecycle rule to abort incomplete multipart uploads, the
/// upload must complete within the number of days specified in the bucket lifecycle configuration.
/// Otherwise, the incomplete multipart upload becomes eligible for an abort action and
/// Amazon S3 aborts the multipart upload. For more information, see Aborting
/// Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration.
///
///
///
/// For information about the permissions required to use the multipart upload API, see
/// Multipart
/// Upload and Permissions.
///
///
///
/// For request signing, multipart upload is just a series of regular requests. You initiate
/// a multipart upload, send one or more requests to upload parts, and then complete the
/// multipart upload process. You sign each request individually. There is nothing special
/// about signing multipart upload requests. For more information about signing, see Authenticating
/// Requests (Amazon Web Services Signature Version 4).
///
///
///
/// 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.
///
///
///
/// 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 UploadPart
/// and UploadPartCopy
/// requests must match the headers you used in the request to initiate the upload by
/// using CreateMultipartUpload. 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).
///
///
///
/// To perform a multipart upload with encryption by using an Amazon Web Services KMS
/// key, the requester must have permission to the kms:Decrypt and kms:GenerateDataKey*
/// actions on the key. These permissions are required because Amazon S3 must decrypt
/// and read data from the encrypted file parts before it completes the multipart upload.
/// For more information, see Multipart
/// upload API and permissions and Protecting
/// data using server-side encryption with Amazon Web Services KMS in the Amazon
/// S3 User Guide.
///
///
///
/// If your Identity and Access Management (IAM) user or role is in the same Amazon Web
/// Services account as the KMS key, then you must have these permissions on the key policy.
/// If your IAM user or role belongs to a different account than the key, then you must
/// have the permissions on both the key policy and your IAM user or role.
///
///
///
/// For more information, see Protecting
/// Data Using Server-Side Encryption.
///
/// - Access Permissions
-
///
/// When copying an object, you can optionally specify the accounts or groups that should
/// be granted specific permissions on the new object. There are two ways to grant the
/// permissions using the request headers:
///
///
-
///
/// Specify a canned ACL with the
x-amz-acl request header. For more information,
/// see Canned
/// ACL.
///
/// -
///
/// Specify access permissions explicitly with the
x-amz-grant-read, x-amz-grant-read-acp,
/// x-amz-grant-write-acp, and x-amz-grant-full-control headers.
/// These parameters map to the set of permissions that Amazon S3 supports in an ACL.
/// For more information, see Access
/// Control List (ACL) Overview.
///
///
///
/// You can use either a canned ACL or specify access permissions explicitly. You cannot
/// do both.
///
/// - Server-Side- Encryption-Specific Request Headers
-
///
/// 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).
///
///
-
///
/// Use KMS keys (SSE-KMS) that include the Amazon Web Services managed key (
aws/s3)
/// 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.
///
/// -
///
///
x-amz-server-side-encryption
///
/// -
///
///
x-amz-server-side-encryption-aws-kms-key-id
///
/// -
///
///
x-amz-server-side-encryption-context
///
///
///
/// If you specify x-amz-server-side-encryption:aws:kms, but don't provide
/// x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the Amazon
/// Web Services managed key (aws/s3 key) in KMS to protect the data.
///
///
///
/// All GET and PUT 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.
///
///
///
/// For more information about server-side encryption with KMS keys (SSE-KMS), see Protecting
/// Data Using Server-Side Encryption with KMS keys.
///
/// -
///
/// Use customer-provided encryption keys (SSE-C) – If you want to manage your own encryption
/// keys, provide all the following headers in the request.
///
///
-
///
///
x-amz-server-side-encryption-customer-algorithm
///
/// -
///
///
x-amz-server-side-encryption-customer-key
///
/// -
///
///
x-amz-server-side-encryption-customer-key-MD5
///
///
///
/// For more information about server-side encryption with customer-provided encryption
/// keys (SSE-C), see
/// Protecting data using server-side encryption with customer-provided encryption keys
/// (SSE-C).
///
///
- Access-Control-List (ACL)-Specific Request Headers
-
///
///
/// You also can use the following access control–related headers with this operation.
/// By default, all objects are private. Only the owner has full access control. When
/// adding a new object, you can grant permissions to individual Amazon Web Services accounts
/// or to predefined groups defined by Amazon S3. These permissions are then added to
/// the access control list (ACL) on the object. For more information, see Using
/// ACLs. With this operation, you can grant access permissions using one of the following
/// two methods:
///
///
-
///
/// Specify a canned ACL (
x-amz-acl) — Amazon S3 supports a set of predefined
/// ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees
/// and permissions. For more information, see Canned
/// ACL.
///
/// -
///
/// Specify access permissions explicitly — To explicitly grant access permissions to
/// specific Amazon Web Services accounts or groups, use the following headers. Each header
/// maps to specific permissions that Amazon S3 supports in an ACL. For more information,
/// see Access
/// Control List (ACL) Overview. In the header, you specify a list of grantees who
/// get the specific permission. To grant permissions explicitly, use:
///
///
-
///
///
x-amz-grant-read
///
/// -
///
///
x-amz-grant-write
///
/// -
///
///
x-amz-grant-read-acp
///
/// -
///
///
x-amz-grant-write-acp
///
/// -
///
///
x-amz-grant-full-control
///
///
///
/// You specify each grantee as a type=value pair, where the type is one of the following:
///
/// -
///
///
id – if the value specified is the canonical user ID of an Amazon Web
/// Services account
///
/// -
///
///
uri – if you are granting permissions to a predefined group
///
/// -
///
///
emailAddress – if the value specified is the email address of an Amazon
/// Web Services account
///
///
///
/// Using email addresses to specify a grantee is only supported in the following Amazon
/// Web Services Regions:
///
/// -
///
/// US East (N. Virginia)
///
///
-
///
/// US West (N. California)
///
///
-
///
/// US West (Oregon)
///
///
-
///
/// Asia Pacific (Singapore)
///
///
-
///
/// Asia Pacific (Sydney)
///
///
-
///
/// Asia Pacific (Tokyo)
///
///
-
///
/// Europe (Ireland)
///
///
-
///
/// South America (São Paulo)
///
///
///
/// For a list of all the Amazon S3 supported Regions and endpoints, see Regions
/// and Endpoints in the Amazon Web Services General Reference.
///
///
///
/// For example, the following x-amz-grant-read header grants the Amazon
/// Web Services accounts identified by account IDs permissions to read object data and
/// its metadata:
///
///
///
/// x-amz-grant-read: id="11112222333", id="444455556666"
///
///
///
/// The following operations are related to CreateMultipartUpload:
///
///
///
/// 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 AccessPointName-AccountId.s3-accesspoint.Region.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 Using access points in the Amazon S3 User Guide. 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 AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. 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 What is S3 on Outposts? in the Amazon S3 User Guide.
/// Object key for which the multipart upload is to be initiated.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the InitiateMultipartUpload service method, as returned by S3.
/// REST API Reference for InitiateMultipartUpload Operation
public virtual Task InitiateMultipartUploadAsync(string bucketName, string key, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var request = new InitiateMultipartUploadRequest();
request.BucketName = bucketName;
request.Key = key;
return InitiateMultipartUploadAsync(request, cancellationToken);
}
///
/// This action initiates a multipart upload and returns an upload ID. This upload ID
/// is used to associate all of the parts in the specific multipart upload. You specify
/// this upload ID in each of your subsequent upload part requests (see UploadPart).
/// You also include this upload ID in the final request to either complete or abort the
/// multipart upload request.
///
///
///
/// For more information about multipart uploads, see Multipart
/// Upload Overview.
///
///
///
/// If you have configured a lifecycle rule to abort incomplete multipart uploads, the
/// upload must complete within the number of days specified in the bucket lifecycle configuration.
/// Otherwise, the incomplete multipart upload becomes eligible for an abort action and
/// Amazon S3 aborts the multipart upload. For more information, see Aborting
/// Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration.
///
///
///
/// For information about the permissions required to use the multipart upload API, see
/// Multipart
/// Upload and Permissions.
///
///
///
/// For request signing, multipart upload is just a series of regular requests. You initiate
/// a multipart upload, send one or more requests to upload parts, and then complete the
/// multipart upload process. You sign each request individually. There is nothing special
/// about signing multipart upload requests. For more information about signing, see Authenticating
/// Requests (Amazon Web Services Signature Version 4).
///
///
///
/// 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.
///
///
///
/// 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 UploadPart
/// and UploadPartCopy
/// requests must match the headers you used in the request to initiate the upload by
/// using CreateMultipartUpload. 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).
///
///
///
/// To perform a multipart upload with encryption by using an Amazon Web Services KMS
/// key, the requester must have permission to the kms:Decrypt and kms:GenerateDataKey*
/// actions on the key. These permissions are required because Amazon S3 must decrypt
/// and read data from the encrypted file parts before it completes the multipart upload.
/// For more information, see Multipart
/// upload API and permissions and Protecting
/// data using server-side encryption with Amazon Web Services KMS in the Amazon
/// S3 User Guide.
///
///
///
/// If your Identity and Access Management (IAM) user or role is in the same Amazon Web
/// Services account as the KMS key, then you must have these permissions on the key policy.
/// If your IAM user or role belongs to a different account than the key, then you must
/// have the permissions on both the key policy and your IAM user or role.
///
///
///
/// For more information, see Protecting
/// Data Using Server-Side Encryption.
///
/// - Access Permissions
-
///
/// When copying an object, you can optionally specify the accounts or groups that should
/// be granted specific permissions on the new object. There are two ways to grant the
/// permissions using the request headers:
///
///
-
///
/// Specify a canned ACL with the
x-amz-acl request header. For more information,
/// see Canned
/// ACL.
///
/// -
///
/// Specify access permissions explicitly with the
x-amz-grant-read, x-amz-grant-read-acp,
/// x-amz-grant-write-acp, and x-amz-grant-full-control headers.
/// These parameters map to the set of permissions that Amazon S3 supports in an ACL.
/// For more information, see Access
/// Control List (ACL) Overview.
///
///
///
/// You can use either a canned ACL or specify access permissions explicitly. You cannot
/// do both.
///
/// - Server-Side- Encryption-Specific Request Headers
-
///
/// 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).
///
///
-
///
/// Use KMS keys (SSE-KMS) that include the Amazon Web Services managed key (
aws/s3)
/// 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.
///
/// -
///
///
x-amz-server-side-encryption
///
/// -
///
///
x-amz-server-side-encryption-aws-kms-key-id
///
/// -
///
///
x-amz-server-side-encryption-context
///
///
///
/// If you specify x-amz-server-side-encryption:aws:kms, but don't provide
/// x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the Amazon
/// Web Services managed key (aws/s3 key) in KMS to protect the data.
///
///
///
/// All GET and PUT 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.
///
///
///
/// For more information about server-side encryption with KMS keys (SSE-KMS), see Protecting
/// Data Using Server-Side Encryption with KMS keys.
///
/// -
///
/// Use customer-provided encryption keys (SSE-C) – If you want to manage your own encryption
/// keys, provide all the following headers in the request.
///
///
-
///
///
x-amz-server-side-encryption-customer-algorithm
///
/// -
///
///
x-amz-server-side-encryption-customer-key
///
/// -
///
///
x-amz-server-side-encryption-customer-key-MD5
///
///
///
/// For more information about server-side encryption with customer-provided encryption
/// keys (SSE-C), see
/// Protecting data using server-side encryption with customer-provided encryption keys
/// (SSE-C).
///
///
- Access-Control-List (ACL)-Specific Request Headers
-
///
///
/// You also can use the following access control–related headers with this operation.
/// By default, all objects are private. Only the owner has full access control. When
/// adding a new object, you can grant permissions to individual Amazon Web Services accounts
/// or to predefined groups defined by Amazon S3. These permissions are then added to
/// the access control list (ACL) on the object. For more information, see Using
/// ACLs. With this operation, you can grant access permissions using one of the following
/// two methods:
///
///
-
///
/// Specify a canned ACL (
x-amz-acl) — Amazon S3 supports a set of predefined
/// ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees
/// and permissions. For more information, see Canned
/// ACL.
///
/// -
///
/// Specify access permissions explicitly — To explicitly grant access permissions to
/// specific Amazon Web Services accounts or groups, use the following headers. Each header
/// maps to specific permissions that Amazon S3 supports in an ACL. For more information,
/// see Access
/// Control List (ACL) Overview. In the header, you specify a list of grantees who
/// get the specific permission. To grant permissions explicitly, use:
///
///
-
///
///
x-amz-grant-read
///
/// -
///
///
x-amz-grant-write
///
/// -
///
///
x-amz-grant-read-acp
///
/// -
///
///
x-amz-grant-write-acp
///
/// -
///
///
x-amz-grant-full-control
///
///
///
/// You specify each grantee as a type=value pair, where the type is one of the following:
///
/// -
///
///
id – if the value specified is the canonical user ID of an Amazon Web
/// Services account
///
/// -
///
///
uri – if you are granting permissions to a predefined group
///
/// -
///
///
emailAddress – if the value specified is the email address of an Amazon
/// Web Services account
///
///
///
/// Using email addresses to specify a grantee is only supported in the following Amazon
/// Web Services Regions:
///
/// -
///
/// US East (N. Virginia)
///
///
-
///
/// US West (N. California)
///
///
-
///
/// US West (Oregon)
///
///
-
///
/// Asia Pacific (Singapore)
///
///
-
///
/// Asia Pacific (Sydney)
///
///
-
///
/// Asia Pacific (Tokyo)
///
///
-
///
/// Europe (Ireland)
///
///
-
///
/// South America (São Paulo)
///
///
///
/// For a list of all the Amazon S3 supported Regions and endpoints, see Regions
/// and Endpoints in the Amazon Web Services General Reference.
///
///
///
/// For example, the following x-amz-grant-read header grants the Amazon
/// Web Services accounts identified by account IDs permissions to read object data and
/// its metadata:
///
///
///
/// x-amz-grant-read: id="11112222333", id="444455556666"
///
///
///
/// The following operations are related to CreateMultipartUpload:
///
///
///
/// Container for the necessary parameters to execute the InitiateMultipartUpload service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the InitiateMultipartUpload service method, as returned by S3.
/// REST API Reference for InitiateMultipartUpload Operation
public virtual Task InitiateMultipartUploadAsync(InitiateMultipartUploadRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = InitiateMultipartUploadRequestMarshaller.Instance;
options.ResponseUnmarshaller = InitiateMultipartUploadResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region ListBucketAnalyticsConfigurations
///
/// Lists the analytics configurations for the bucket. You can have up to 1,000 analytics
/// configurations per bucket.
///
///
///
/// This action supports list pagination and does not return more than 100 configurations
/// at a time. You should always check the IsTruncated element in the response.
/// If there are no more configurations to list, IsTruncated is set to false.
/// If there are more configurations to list, IsTruncated is set to true,
/// and there will be a value in NextContinuationToken. You use the NextContinuationToken
/// value to continue the pagination of the list by passing the value in continuation-token
/// in the request to GET the next page.
///
///
///
/// To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration
/// action. The bucket owner has this permission by default. The bucket owner can grant
/// this permission to others. For more information about permissions, see Permissions
/// Related to Bucket Subresource Operations and Managing
/// Access Permissions to Your Amazon S3 Resources.
///
///
///
/// For information about Amazon S3 analytics feature, see Amazon
/// S3 Analytics – Storage Class Analysis.
///
///
///
/// The following operations are related to ListBucketAnalyticsConfigurations:
///
///
///
/// Container for the necessary parameters to execute the ListBucketAnalyticsConfigurations service method.
///
/// The response from the ListBucketAnalyticsConfigurations service method, as returned by S3.
/// REST API Reference for ListBucketAnalyticsConfigurations Operation
public virtual ListBucketAnalyticsConfigurationsResponse ListBucketAnalyticsConfigurations(ListBucketAnalyticsConfigurationsRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListBucketAnalyticsConfigurationsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListBucketAnalyticsConfigurationsResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Lists the analytics configurations for the bucket. You can have up to 1,000 analytics
/// configurations per bucket.
///
///
///
/// This action supports list pagination and does not return more than 100 configurations
/// at a time. You should always check the IsTruncated element in the response.
/// If there are no more configurations to list, IsTruncated is set to false.
/// If there are more configurations to list, IsTruncated is set to true,
/// and there will be a value in NextContinuationToken. You use the NextContinuationToken
/// value to continue the pagination of the list by passing the value in continuation-token
/// in the request to GET the next page.
///
///
///
/// To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration
/// action. The bucket owner has this permission by default. The bucket owner can grant
/// this permission to others. For more information about permissions, see Permissions
/// Related to Bucket Subresource Operations and Managing
/// Access Permissions to Your Amazon S3 Resources.
///
///
///
/// For information about Amazon S3 analytics feature, see Amazon
/// S3 Analytics – Storage Class Analysis.
///
///
///
/// The following operations are related to ListBucketAnalyticsConfigurations:
///
///
///
/// Container for the necessary parameters to execute the ListBucketAnalyticsConfigurations service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListBucketAnalyticsConfigurations service method, as returned by S3.
/// REST API Reference for ListBucketAnalyticsConfigurations Operation
public virtual Task ListBucketAnalyticsConfigurationsAsync(ListBucketAnalyticsConfigurationsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = ListBucketAnalyticsConfigurationsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListBucketAnalyticsConfigurationsResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region ListBucketIntelligentTieringConfigurations
///
/// Lists the S3 Intelligent-Tiering configuration from the specified bucket.
///
///
///
/// The S3 Intelligent-Tiering storage class is designed to optimize storage costs by
/// automatically moving data to the most cost-effective storage access tier, without
/// performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic
/// cost savings in three low latency and high throughput access tiers. To get the lowest
/// storage cost on data that can be accessed in minutes to hours, you can choose to activate
/// additional archiving capabilities.
///
///
///
/// The S3 Intelligent-Tiering storage class is the ideal storage class for data with
/// unknown, changing, or unpredictable access patterns, independent of object size or
/// retention period. If the size of an object is less than 128 KB, it is not monitored
/// and not eligible for auto-tiering. Smaller objects can be stored, but they are always
/// charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.
///
///
///
/// For more information, see Storage
/// class for automatically optimizing frequently and infrequently accessed objects.
///
///
///
/// Operations related to ListBucketIntelligentTieringConfigurations include:
///
///
///
///
/// Container for the necessary parameters to execute the ListBucketIntelligentTieringConfigurations service method.
///
/// The response from the ListBucketIntelligentTieringConfigurations service method, as returned by S3.
/// REST API Reference for ListBucketIntelligentTieringConfigurations Operation
public virtual ListBucketIntelligentTieringConfigurationsResponse ListBucketIntelligentTieringConfigurations(ListBucketIntelligentTieringConfigurationsRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListBucketIntelligentTieringConfigurationsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListBucketIntelligentTieringConfigurationsResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Lists the S3 Intelligent-Tiering configuration from the specified bucket.
///
///
///
/// The S3 Intelligent-Tiering storage class is designed to optimize storage costs by
/// automatically moving data to the most cost-effective storage access tier, without
/// performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic
/// cost savings in three low latency and high throughput access tiers. To get the lowest
/// storage cost on data that can be accessed in minutes to hours, you can choose to activate
/// additional archiving capabilities.
///
///
///
/// The S3 Intelligent-Tiering storage class is the ideal storage class for data with
/// unknown, changing, or unpredictable access patterns, independent of object size or
/// retention period. If the size of an object is less than 128 KB, it is not monitored
/// and not eligible for auto-tiering. Smaller objects can be stored, but they are always
/// charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.
///
///
///
/// For more information, see Storage
/// class for automatically optimizing frequently and infrequently accessed objects.
///
///
///
/// Operations related to ListBucketIntelligentTieringConfigurations include:
///
///
///
///
/// Container for the necessary parameters to execute the ListBucketIntelligentTieringConfigurations service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListBucketIntelligentTieringConfigurations service method, as returned by S3.
/// REST API Reference for ListBucketIntelligentTieringConfigurations Operation
public virtual Task ListBucketIntelligentTieringConfigurationsAsync(ListBucketIntelligentTieringConfigurationsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = ListBucketIntelligentTieringConfigurationsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListBucketIntelligentTieringConfigurationsResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region ListBucketInventoryConfigurations
///
/// Returns a list of inventory configurations for the bucket. You can have up to 1,000
/// analytics configurations per bucket.
///
///
///
/// This action supports list pagination and does not return more than 100 configurations
/// at a time. Always check the IsTruncated element in the response. If there
/// are no more configurations to list, IsTruncated is set to false. If there
/// are more configurations to list, IsTruncated is set to true, and there
/// is a value in NextContinuationToken. You use the NextContinuationToken
/// value to continue the pagination of the list by passing the value in continuation-token
/// in the request to GET the next page.
///
///
///
/// To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration
/// action. The bucket owner has this permission by default. The bucket owner can grant
/// this permission to others. For more information about permissions, see Permissions
/// Related to Bucket Subresource Operations and Managing
/// Access Permissions to Your Amazon S3 Resources.
///
///
///
/// For information about the Amazon S3 inventory feature, see Amazon
/// S3 Inventory
///
///
///
/// The following operations are related to ListBucketInventoryConfigurations:
///
///
///
/// Container for the necessary parameters to execute the ListBucketInventoryConfigurations service method.
///
/// The response from the ListBucketInventoryConfigurations service method, as returned by S3.
/// REST API Reference for ListBucketInventoryConfigurations Operation
public virtual ListBucketInventoryConfigurationsResponse ListBucketInventoryConfigurations(ListBucketInventoryConfigurationsRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListBucketInventoryConfigurationsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListBucketInventoryConfigurationsResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Returns a list of inventory configurations for the bucket. You can have up to 1,000
/// analytics configurations per bucket.
///
///
///
/// This action supports list pagination and does not return more than 100 configurations
/// at a time. Always check the IsTruncated element in the response. If there
/// are no more configurations to list, IsTruncated is set to false. If there
/// are more configurations to list, IsTruncated is set to true, and there
/// is a value in NextContinuationToken. You use the NextContinuationToken
/// value to continue the pagination of the list by passing the value in continuation-token
/// in the request to GET the next page.
///
///
///
/// To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration
/// action. The bucket owner has this permission by default. The bucket owner can grant
/// this permission to others. For more information about permissions, see Permissions
/// Related to Bucket Subresource Operations and Managing
/// Access Permissions to Your Amazon S3 Resources.
///
///
///
/// For information about the Amazon S3 inventory feature, see Amazon
/// S3 Inventory
///
///
///
/// The following operations are related to ListBucketInventoryConfigurations:
///
///
///
/// Container for the necessary parameters to execute the ListBucketInventoryConfigurations service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListBucketInventoryConfigurations service method, as returned by S3.
/// REST API Reference for ListBucketInventoryConfigurations Operation
public virtual Task ListBucketInventoryConfigurationsAsync(ListBucketInventoryConfigurationsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = ListBucketInventoryConfigurationsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListBucketInventoryConfigurationsResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region ListBucketMetricsConfigurations
///
/// Lists the metrics configurations for the bucket. The metrics configurations are only
/// for the request metrics of the bucket and do not provide information on daily storage
/// metrics. You can have up to 1,000 configurations per bucket.
///
///
///
/// This action supports list pagination and does not return more than 100 configurations
/// at a time. Always check the IsTruncated element in the response. If there
/// are no more configurations to list, IsTruncated is set to false. If there
/// are more configurations to list, IsTruncated is set to true, and there
/// is a value in NextContinuationToken. You use the NextContinuationToken
/// value to continue the pagination of the list by passing the value in continuation-token
/// in the request to GET the next page.
///
///
///
/// To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration
/// action. The bucket owner has this permission by default. The bucket owner can grant
/// this permission to others. For more information about permissions, see Permissions
/// Related to Bucket Subresource Operations and Managing
/// Access Permissions to Your Amazon S3 Resources.
///
///
///
/// For more information about metrics configurations and CloudWatch request metrics,
/// see Monitoring
/// Metrics with Amazon CloudWatch.
///
///
///
/// The following operations are related to ListBucketMetricsConfigurations:
///
///
///
/// Container for the necessary parameters to execute the ListBucketMetricsConfigurations service method.
///
/// The response from the ListBucketMetricsConfigurations service method, as returned by S3.
/// REST API Reference for ListBucketMetricsConfigurations Operation
public virtual ListBucketMetricsConfigurationsResponse ListBucketMetricsConfigurations(ListBucketMetricsConfigurationsRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListBucketMetricsConfigurationsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListBucketMetricsConfigurationsResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Lists the metrics configurations for the bucket. The metrics configurations are only
/// for the request metrics of the bucket and do not provide information on daily storage
/// metrics. You can have up to 1,000 configurations per bucket.
///
///
///
/// This action supports list pagination and does not return more than 100 configurations
/// at a time. Always check the IsTruncated element in the response. If there
/// are no more configurations to list, IsTruncated is set to false. If there
/// are more configurations to list, IsTruncated is set to true, and there
/// is a value in NextContinuationToken. You use the NextContinuationToken
/// value to continue the pagination of the list by passing the value in continuation-token
/// in the request to GET the next page.
///
///
///
/// To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration
/// action. The bucket owner has this permission by default. The bucket owner can grant
/// this permission to others. For more information about permissions, see Permissions
/// Related to Bucket Subresource Operations and Managing
/// Access Permissions to Your Amazon S3 Resources.
///
///
///
/// For more information about metrics configurations and CloudWatch request metrics,
/// see Monitoring
/// Metrics with Amazon CloudWatch.
///
///
///
/// The following operations are related to ListBucketMetricsConfigurations:
///
///
///
/// Container for the necessary parameters to execute the ListBucketMetricsConfigurations service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListBucketMetricsConfigurations service method, as returned by S3.
/// REST API Reference for ListBucketMetricsConfigurations Operation
public virtual Task ListBucketMetricsConfigurationsAsync(ListBucketMetricsConfigurationsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = ListBucketMetricsConfigurationsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListBucketMetricsConfigurationsResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region ListBuckets
///
/// Returns a list of all buckets owned by the authenticated sender of the request. To
/// use this operation, you must have the s3:ListAllMyBuckets permission.
///
///
///
///
/// For information about Amazon S3 buckets, see Creating,
/// configuring, and working with Amazon S3 buckets.
///
///
///
/// The response from the ListBuckets service method, as returned by S3.
/// REST API Reference for ListBuckets Operation
public virtual ListBucketsResponse ListBuckets()
{
return ListBuckets(new ListBucketsRequest());
}
///
/// Returns a list of all buckets owned by the authenticated sender of the request. To
/// use this operation, you must have the s3:ListAllMyBuckets permission.
///
///
///
///
/// For information about Amazon S3 buckets, see Creating,
/// configuring, and working with Amazon S3 buckets.
///
///
/// Container for the necessary parameters to execute the ListBuckets service method.
///
/// The response from the ListBuckets service method, as returned by S3.
/// REST API Reference for ListBuckets Operation
public virtual ListBucketsResponse ListBuckets(ListBucketsRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListBucketsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListBucketsResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Returns a list of all buckets owned by the authenticated sender of the request. To
/// use this operation, you must have the s3:ListAllMyBuckets permission.
///
///
///
///
/// For information about Amazon S3 buckets, see Creating,
/// configuring, and working with Amazon S3 buckets.
///
///
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListBuckets service method, as returned by S3.
/// REST API Reference for ListBuckets Operation
public virtual Task ListBucketsAsync(System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
return ListBucketsAsync(new ListBucketsRequest(), cancellationToken);
}
///
/// Returns a list of all buckets owned by the authenticated sender of the request. To
/// use this operation, you must have the s3:ListAllMyBuckets permission.
///
///
///
///
/// For information about Amazon S3 buckets, see Creating,
/// configuring, and working with Amazon S3 buckets.
///
///
/// Container for the necessary parameters to execute the ListBuckets service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListBuckets service method, as returned by S3.
/// REST API Reference for ListBuckets Operation
public virtual Task ListBucketsAsync(ListBucketsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = ListBucketsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListBucketsResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region ListMultipartUploads
///
/// This action lists in-progress multipart uploads. An in-progress multipart upload is
/// a multipart upload that has been initiated using the Initiate Multipart Upload request,
/// but has not yet been completed or aborted.
///
///
///
/// This action returns at most 1,000 multipart uploads in the response. 1,000 multipart
/// uploads is the maximum number of uploads a response can include, which is also the
/// default value. You can further limit the number of uploads in a response by specifying
/// the max-uploads parameter in the response. If additional multipart uploads
/// satisfy the list criteria, the response will contain an IsTruncated element
/// with the value true. To list the additional multipart uploads, use the key-marker
/// and upload-id-marker request parameters.
///
///
///
/// In the response, the uploads are sorted by key. If your application has initiated
/// more than one multipart upload using the same object key, then uploads in the response
/// are first sorted by key. Additionally, uploads are sorted in ascending order within
/// each key by the upload initiation time.
///
///
///
/// For more information on multipart uploads, see Uploading
/// Objects Using Multipart Upload.
///
///
///
/// For information on permissions required to use the multipart upload API, see Multipart
/// Upload and Permissions.
///
///
///
/// The following operations are related to ListMultipartUploads:
///
///
///
/// 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 AccessPointName-AccountId.s3-accesspoint.Region.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 Using access points in the Amazon S3 User Guide. 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 AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. 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 What is S3 on Outposts? in the Amazon S3 User Guide.
///
/// The response from the ListMultipartUploads service method, as returned by S3.
/// REST API Reference for ListMultipartUploads Operation
public virtual ListMultipartUploadsResponse ListMultipartUploads(string bucketName)
{
var request = new ListMultipartUploadsRequest();
request.BucketName = bucketName;
return ListMultipartUploads(request);
}
///
/// This action lists in-progress multipart uploads. An in-progress multipart upload is
/// a multipart upload that has been initiated using the Initiate Multipart Upload request,
/// but has not yet been completed or aborted.
///
///
///
/// This action returns at most 1,000 multipart uploads in the response. 1,000 multipart
/// uploads is the maximum number of uploads a response can include, which is also the
/// default value. You can further limit the number of uploads in a response by specifying
/// the max-uploads parameter in the response. If additional multipart uploads
/// satisfy the list criteria, the response will contain an IsTruncated element
/// with the value true. To list the additional multipart uploads, use the key-marker
/// and upload-id-marker request parameters.
///
///
///
/// In the response, the uploads are sorted by key. If your application has initiated
/// more than one multipart upload using the same object key, then uploads in the response
/// are first sorted by key. Additionally, uploads are sorted in ascending order within
/// each key by the upload initiation time.
///
///
///
/// For more information on multipart uploads, see Uploading
/// Objects Using Multipart Upload.
///
///
///
/// For information on permissions required to use the multipart upload API, see Multipart
/// Upload and Permissions.
///
///
///
/// The following operations are related to ListMultipartUploads:
///
///
///
/// 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 AccessPointName-AccountId.s3-accesspoint.Region.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 Using access points in the Amazon S3 User Guide. 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 AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. 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 What is S3 on Outposts? in the Amazon S3 User Guide.
/// 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 prefix to make groups in the same way that you'd use a folder in a file system.)
///
/// The response from the ListMultipartUploads service method, as returned by S3.
/// REST API Reference for ListMultipartUploads Operation
public virtual ListMultipartUploadsResponse ListMultipartUploads(string bucketName, string prefix)
{
var request = new ListMultipartUploadsRequest();
request.BucketName = bucketName;
request.Prefix = prefix;
return ListMultipartUploads(request);
}
///
/// This action lists in-progress multipart uploads. An in-progress multipart upload is
/// a multipart upload that has been initiated using the Initiate Multipart Upload request,
/// but has not yet been completed or aborted.
///
///
///
/// This action returns at most 1,000 multipart uploads in the response. 1,000 multipart
/// uploads is the maximum number of uploads a response can include, which is also the
/// default value. You can further limit the number of uploads in a response by specifying
/// the max-uploads parameter in the response. If additional multipart uploads
/// satisfy the list criteria, the response will contain an IsTruncated element
/// with the value true. To list the additional multipart uploads, use the key-marker
/// and upload-id-marker request parameters.
///
///
///
/// In the response, the uploads are sorted by key. If your application has initiated
/// more than one multipart upload using the same object key, then uploads in the response
/// are first sorted by key. Additionally, uploads are sorted in ascending order within
/// each key by the upload initiation time.
///
///
///
/// For more information on multipart uploads, see Uploading
/// Objects Using Multipart Upload.
///
///
///
/// For information on permissions required to use the multipart upload API, see Multipart
/// Upload and Permissions.
///
///
///
/// The following operations are related to ListMultipartUploads:
///
///
///
/// Container for the necessary parameters to execute the ListMultipartUploads service method.
///
/// The response from the ListMultipartUploads service method, as returned by S3.
/// REST API Reference for ListMultipartUploads Operation
public virtual ListMultipartUploadsResponse ListMultipartUploads(ListMultipartUploadsRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListMultipartUploadsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListMultipartUploadsResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// This action lists in-progress multipart uploads. An in-progress multipart upload is
/// a multipart upload that has been initiated using the Initiate Multipart Upload request,
/// but has not yet been completed or aborted.
///
///
///
/// This action returns at most 1,000 multipart uploads in the response. 1,000 multipart
/// uploads is the maximum number of uploads a response can include, which is also the
/// default value. You can further limit the number of uploads in a response by specifying
/// the max-uploads parameter in the response. If additional multipart uploads
/// satisfy the list criteria, the response will contain an IsTruncated element
/// with the value true. To list the additional multipart uploads, use the key-marker
/// and upload-id-marker request parameters.
///
///
///
/// In the response, the uploads are sorted by key. If your application has initiated
/// more than one multipart upload using the same object key, then uploads in the response
/// are first sorted by key. Additionally, uploads are sorted in ascending order within
/// each key by the upload initiation time.
///
///
///
/// For more information on multipart uploads, see Uploading
/// Objects Using Multipart Upload.
///
///
///
/// For information on permissions required to use the multipart upload API, see Multipart
/// Upload and Permissions.
///
///
///
/// The following operations are related to ListMultipartUploads:
///
///
///
/// 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 AccessPointName-AccountId.s3-accesspoint.Region.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 Using access points in the Amazon S3 User Guide. 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 AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. 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 What is S3 on Outposts? in the Amazon S3 User Guide.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListMultipartUploads service method, as returned by S3.
/// REST API Reference for ListMultipartUploads Operation
public virtual Task ListMultipartUploadsAsync(string bucketName, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var request = new ListMultipartUploadsRequest();
request.BucketName = bucketName;
return ListMultipartUploadsAsync(request, cancellationToken);
}
///
/// This action lists in-progress multipart uploads. An in-progress multipart upload is
/// a multipart upload that has been initiated using the Initiate Multipart Upload request,
/// but has not yet been completed or aborted.
///
///
///
/// This action returns at most 1,000 multipart uploads in the response. 1,000 multipart
/// uploads is the maximum number of uploads a response can include, which is also the
/// default value. You can further limit the number of uploads in a response by specifying
/// the max-uploads parameter in the response. If additional multipart uploads
/// satisfy the list criteria, the response will contain an IsTruncated element
/// with the value true. To list the additional multipart uploads, use the key-marker
/// and upload-id-marker request parameters.
///
///
///
/// In the response, the uploads are sorted by key. If your application has initiated
/// more than one multipart upload using the same object key, then uploads in the response
/// are first sorted by key. Additionally, uploads are sorted in ascending order within
/// each key by the upload initiation time.
///
///
///
/// For more information on multipart uploads, see Uploading
/// Objects Using Multipart Upload.
///
///
///
/// For information on permissions required to use the multipart upload API, see Multipart
/// Upload and Permissions.
///
///
///
/// The following operations are related to ListMultipartUploads:
///
///
///
/// 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 AccessPointName-AccountId.s3-accesspoint.Region.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 Using access points in the Amazon S3 User Guide. 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 AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. 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 What is S3 on Outposts? in the Amazon S3 User Guide.
/// 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 prefix to make groups in the same way that you'd use a folder in a file system.)
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListMultipartUploads service method, as returned by S3.
/// REST API Reference for ListMultipartUploads Operation
public virtual Task ListMultipartUploadsAsync(string bucketName, string prefix, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var request = new ListMultipartUploadsRequest();
request.BucketName = bucketName;
request.Prefix = prefix;
return ListMultipartUploadsAsync(request, cancellationToken);
}
///
/// This action lists in-progress multipart uploads. An in-progress multipart upload is
/// a multipart upload that has been initiated using the Initiate Multipart Upload request,
/// but has not yet been completed or aborted.
///
///
///
/// This action returns at most 1,000 multipart uploads in the response. 1,000 multipart
/// uploads is the maximum number of uploads a response can include, which is also the
/// default value. You can further limit the number of uploads in a response by specifying
/// the max-uploads parameter in the response. If additional multipart uploads
/// satisfy the list criteria, the response will contain an IsTruncated element
/// with the value true. To list the additional multipart uploads, use the key-marker
/// and upload-id-marker request parameters.
///
///
///
/// In the response, the uploads are sorted by key. If your application has initiated
/// more than one multipart upload using the same object key, then uploads in the response
/// are first sorted by key. Additionally, uploads are sorted in ascending order within
/// each key by the upload initiation time.
///
///
///
/// For more information on multipart uploads, see Uploading
/// Objects Using Multipart Upload.
///
///
///
/// For information on permissions required to use the multipart upload API, see Multipart
/// Upload and Permissions.
///
///
///
/// The following operations are related to ListMultipartUploads:
///
///
///
/// Container for the necessary parameters to execute the ListMultipartUploads service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListMultipartUploads service method, as returned by S3.
/// REST API Reference for ListMultipartUploads Operation
public virtual Task ListMultipartUploadsAsync(ListMultipartUploadsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = ListMultipartUploadsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListMultipartUploadsResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region ListObjects
///
/// Returns some or all (up to 1,000) of the objects in a bucket. You can use the request
/// parameters as selection criteria to return a subset of the objects in a bucket. A
/// 200 OK response can contain valid or invalid XML. Be sure to design your application
/// to parse the contents of the response and handle it appropriately.
///
///
///
/// This action has been revised. We recommend that you use the newer version, ListObjectsV2,
/// when developing applications. For backward compatibility, Amazon S3 continues to support
/// ListObjects.
///
///
///
/// The following operations are related to ListObjects:
///
///
///
/// 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 AccessPointName-AccountId.s3-accesspoint.Region.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 Using access points in the Amazon S3 User Guide. 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 AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. 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 What is S3 on Outposts? in the Amazon S3 User Guide.
///
/// The response from the ListObjects service method, as returned by S3.
/// REST API Reference for ListObjects Operation
public virtual ListObjectsResponse ListObjects(string bucketName)
{
var request = new ListObjectsRequest();
request.BucketName = bucketName;
return ListObjects(request);
}
///
/// Returns some or all (up to 1,000) of the objects in a bucket. You can use the request
/// parameters as selection criteria to return a subset of the objects in a bucket. A
/// 200 OK response can contain valid or invalid XML. Be sure to design your application
/// to parse the contents of the response and handle it appropriately.
///
///
///
/// This action has been revised. We recommend that you use the newer version, ListObjectsV2,
/// when developing applications. For backward compatibility, Amazon S3 continues to support
/// ListObjects.
///
///
///
/// The following operations are related to ListObjects:
///
///
///
/// 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 AccessPointName-AccountId.s3-accesspoint.Region.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 Using access points in the Amazon S3 User Guide. 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 AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. 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 What is S3 on Outposts? in the Amazon S3 User Guide.
/// Limits the response to keys that begin with the specified prefix.
///
/// The response from the ListObjects service method, as returned by S3.
/// REST API Reference for ListObjects Operation
public virtual ListObjectsResponse ListObjects(string bucketName, string prefix)
{
var request = new ListObjectsRequest();
request.BucketName = bucketName;
request.Prefix = prefix;
return ListObjects(request);
}
///
/// Returns some or all (up to 1,000) of the objects in a bucket. You can use the request
/// parameters as selection criteria to return a subset of the objects in a bucket. A
/// 200 OK response can contain valid or invalid XML. Be sure to design your application
/// to parse the contents of the response and handle it appropriately.
///
///
///
/// This action has been revised. We recommend that you use the newer version, ListObjectsV2,
/// when developing applications. For backward compatibility, Amazon S3 continues to support
/// ListObjects.
///
///
///
/// The following operations are related to ListObjects:
///
///
///
/// Container for the necessary parameters to execute the ListObjects service method.
///
/// The response from the ListObjects service method, as returned by S3.
/// REST API Reference for ListObjects Operation
public virtual ListObjectsResponse ListObjects(ListObjectsRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListObjectsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListObjectsResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Returns some or all (up to 1,000) of the objects in a bucket. You can use the request
/// parameters as selection criteria to return a subset of the objects in a bucket. A
/// 200 OK response can contain valid or invalid XML. Be sure to design your application
/// to parse the contents of the response and handle it appropriately.
///
///
///
/// This action has been revised. We recommend that you use the newer version, ListObjectsV2,
/// when developing applications. For backward compatibility, Amazon S3 continues to support
/// ListObjects.
///
///
///
/// The following operations are related to ListObjects:
///
///
///
/// 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 AccessPointName-AccountId.s3-accesspoint.Region.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 Using access points in the Amazon S3 User Guide. 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 AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. 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 What is S3 on Outposts? in the Amazon S3 User Guide.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListObjects service method, as returned by S3.
/// REST API Reference for ListObjects Operation
public virtual Task ListObjectsAsync(string bucketName, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var request = new ListObjectsRequest();
request.BucketName = bucketName;
return ListObjectsAsync(request, cancellationToken);
}
///
/// Returns some or all (up to 1,000) of the objects in a bucket. You can use the request
/// parameters as selection criteria to return a subset of the objects in a bucket. A
/// 200 OK response can contain valid or invalid XML. Be sure to design your application
/// to parse the contents of the response and handle it appropriately.
///
///
///
/// This action has been revised. We recommend that you use the newer version, ListObjectsV2,
/// when developing applications. For backward compatibility, Amazon S3 continues to support
/// ListObjects.
///
///
///
/// The following operations are related to ListObjects:
///
///
///
/// 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 AccessPointName-AccountId.s3-accesspoint.Region.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 Using access points in the Amazon S3 User Guide. 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 AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. 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 What is S3 on Outposts? in the Amazon S3 User Guide.
/// Limits the response to keys that begin with the specified prefix.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListObjects service method, as returned by S3.
/// REST API Reference for ListObjects Operation
public virtual Task ListObjectsAsync(string bucketName, string prefix, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var request = new ListObjectsRequest();
request.BucketName = bucketName;
request.Prefix = prefix;
return ListObjectsAsync(request, cancellationToken);
}
///
/// Returns some or all (up to 1,000) of the objects in a bucket. You can use the request
/// parameters as selection criteria to return a subset of the objects in a bucket. A
/// 200 OK response can contain valid or invalid XML. Be sure to design your application
/// to parse the contents of the response and handle it appropriately.
///
///
///
/// This action has been revised. We recommend that you use the newer version, ListObjectsV2,
/// when developing applications. For backward compatibility, Amazon S3 continues to support
/// ListObjects.
///
///
///
/// The following operations are related to ListObjects:
///
///
///
/// Container for the necessary parameters to execute the ListObjects service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListObjects service method, as returned by S3.
/// REST API Reference for ListObjects Operation
public virtual Task ListObjectsAsync(ListObjectsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = ListObjectsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListObjectsResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region ListObjectsV2
///
/// Returns some or all (up to 1,000) of the objects in a bucket with each request. You
/// can use the request parameters as selection criteria to return a subset of the objects
/// in a bucket. A 200 OK response can contain valid or invalid XML. Make
/// sure to design your application to parse the contents of the response and handle it
/// appropriately. Objects are returned sorted in an ascending order of the respective
/// key names in the list. For more information about listing objects, see Listing
/// object keys programmatically in the Amazon S3 User Guide.
///
///
///
/// To use this operation, you must have READ access to the bucket.
///
///
///
/// To use this action in an Identity and Access Management (IAM) policy, you must have
/// permission to perform the s3:ListBucket action. The bucket owner has
/// this permission by default and can grant this permission to others. For more information
/// about permissions, see Permissions
/// Related to Bucket Subresource Operations and Managing
/// Access Permissions to Your Amazon S3 Resources in the Amazon S3 User Guide.
///
///
///
/// This section describes the latest revision of this action. We recommend that you use
/// this revised API operation for application development. For backward compatibility,
/// Amazon S3 continues to support the prior version of this API operation, ListObjects.
///
///
///
/// To get a list of your buckets, see ListBuckets.
///
///
///
/// The following operations are related to ListObjectsV2:
///
///
///
/// Container for the necessary parameters to execute the ListObjectsV2 service method.
///
/// The response from the ListObjectsV2 service method, as returned by S3.
/// REST API Reference for ListObjectsV2 Operation
public virtual ListObjectsV2Response ListObjectsV2(ListObjectsV2Request request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListObjectsV2RequestMarshaller.Instance;
options.ResponseUnmarshaller = ListObjectsV2ResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Returns some or all (up to 1,000) of the objects in a bucket with each request. You
/// can use the request parameters as selection criteria to return a subset of the objects
/// in a bucket. A 200 OK response can contain valid or invalid XML. Make
/// sure to design your application to parse the contents of the response and handle it
/// appropriately. Objects are returned sorted in an ascending order of the respective
/// key names in the list. For more information about listing objects, see Listing
/// object keys programmatically in the Amazon S3 User Guide.
///
///
///
/// To use this operation, you must have READ access to the bucket.
///
///
///
/// To use this action in an Identity and Access Management (IAM) policy, you must have
/// permission to perform the s3:ListBucket action. The bucket owner has
/// this permission by default and can grant this permission to others. For more information
/// about permissions, see Permissions
/// Related to Bucket Subresource Operations and Managing
/// Access Permissions to Your Amazon S3 Resources in the Amazon S3 User Guide.
///
///
///
/// This section describes the latest revision of this action. We recommend that you use
/// this revised API operation for application development. For backward compatibility,
/// Amazon S3 continues to support the prior version of this API operation, ListObjects.
///
///
///
/// To get a list of your buckets, see ListBuckets.
///
///
///
/// The following operations are related to ListObjectsV2:
///
///
///
/// Container for the necessary parameters to execute the ListObjectsV2 service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListObjectsV2 service method, as returned by S3.
/// REST API Reference for ListObjectsV2 Operation
public virtual Task ListObjectsV2Async(ListObjectsV2Request request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = ListObjectsV2RequestMarshaller.Instance;
options.ResponseUnmarshaller = ListObjectsV2ResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region ListParts
///
/// Lists the parts that have been uploaded for a specific multipart upload. This operation
/// must include the upload ID, which you obtain by sending the initiate multipart upload
/// request (see CreateMultipartUpload).
/// This request returns a maximum of 1,000 uploaded parts. The default number of parts
/// returned is 1,000 parts. You can restrict the number of parts returned by specifying
/// the max-parts request parameter. If your multipart upload consists of
/// more than 1,000 parts, the response returns an IsTruncated field with
/// the value of true, and a NextPartNumberMarker element. In subsequent
/// ListParts requests you can include the part-number-marker query string
/// parameter and set its value to the NextPartNumberMarker field value from
/// the previous response.
///
///
///
/// If the upload was created using a checksum algorithm, you will need to have permission
/// to the kms:Decrypt action for the request to succeed.
///
///
///
/// For more information on multipart uploads, see Uploading
/// Objects Using Multipart Upload.
///
///
///
/// For information on permissions required to use the multipart upload API, see Multipart
/// Upload and Permissions.
///
///
///
/// The following operations are related to ListParts:
///
///
///
/// 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 AccessPointName-AccountId.s3-accesspoint.Region.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 Using access points in the Amazon S3 User Guide. 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 AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. 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 What is S3 on Outposts? in the Amazon S3 User Guide.
/// Object key for which the multipart upload was initiated.
/// Upload ID identifying the multipart upload whose parts are being listed.
///
/// The response from the ListParts service method, as returned by S3.
/// REST API Reference for ListParts Operation
public virtual ListPartsResponse ListParts(string bucketName, string key, string uploadId)
{
var request = new ListPartsRequest();
request.BucketName = bucketName;
request.Key = key;
request.UploadId = uploadId;
return ListParts(request);
}
///
/// Lists the parts that have been uploaded for a specific multipart upload. This operation
/// must include the upload ID, which you obtain by sending the initiate multipart upload
/// request (see CreateMultipartUpload).
/// This request returns a maximum of 1,000 uploaded parts. The default number of parts
/// returned is 1,000 parts. You can restrict the number of parts returned by specifying
/// the max-parts request parameter. If your multipart upload consists of
/// more than 1,000 parts, the response returns an IsTruncated field with
/// the value of true, and a NextPartNumberMarker element. In subsequent
/// ListParts requests you can include the part-number-marker query string
/// parameter and set its value to the NextPartNumberMarker field value from
/// the previous response.
///
///
///
/// If the upload was created using a checksum algorithm, you will need to have permission
/// to the kms:Decrypt action for the request to succeed.
///
///
///
/// For more information on multipart uploads, see Uploading
/// Objects Using Multipart Upload.
///
///
///
/// For information on permissions required to use the multipart upload API, see Multipart
/// Upload and Permissions.
///
///
///
/// The following operations are related to ListParts:
///
///
///
/// Container for the necessary parameters to execute the ListParts service method.
///
/// The response from the ListParts service method, as returned by S3.
/// REST API Reference for ListParts Operation
public virtual ListPartsResponse ListParts(ListPartsRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListPartsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListPartsResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Lists the parts that have been uploaded for a specific multipart upload. This operation
/// must include the upload ID, which you obtain by sending the initiate multipart upload
/// request (see CreateMultipartUpload).
/// This request returns a maximum of 1,000 uploaded parts. The default number of parts
/// returned is 1,000 parts. You can restrict the number of parts returned by specifying
/// the max-parts request parameter. If your multipart upload consists of
/// more than 1,000 parts, the response returns an IsTruncated field with
/// the value of true, and a NextPartNumberMarker element. In subsequent
/// ListParts requests you can include the part-number-marker query string
/// parameter and set its value to the NextPartNumberMarker field value from
/// the previous response.
///
///
///
/// If the upload was created using a checksum algorithm, you will need to have permission
/// to the kms:Decrypt action for the request to succeed.
///
///
///
/// For more information on multipart uploads, see Uploading
/// Objects Using Multipart Upload.
///
///
///
/// For information on permissions required to use the multipart upload API, see Multipart
/// Upload and Permissions.
///
///
///
/// The following operations are related to ListParts:
///
///
///
/// 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 AccessPointName-AccountId.s3-accesspoint.Region.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 Using access points in the Amazon S3 User Guide. 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 AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. 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 What is S3 on Outposts? in the Amazon S3 User Guide.
/// Object key for which the multipart upload was initiated.
/// Upload ID identifying the multipart upload whose parts are being listed.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListParts service method, as returned by S3.
/// REST API Reference for ListParts Operation
public virtual Task ListPartsAsync(string bucketName, string key, string uploadId, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var request = new ListPartsRequest();
request.BucketName = bucketName;
request.Key = key;
request.UploadId = uploadId;
return ListPartsAsync(request, cancellationToken);
}
///
/// Lists the parts that have been uploaded for a specific multipart upload. This operation
/// must include the upload ID, which you obtain by sending the initiate multipart upload
/// request (see CreateMultipartUpload).
/// This request returns a maximum of 1,000 uploaded parts. The default number of parts
/// returned is 1,000 parts. You can restrict the number of parts returned by specifying
/// the max-parts request parameter. If your multipart upload consists of
/// more than 1,000 parts, the response returns an IsTruncated field with
/// the value of true, and a NextPartNumberMarker element. In subsequent
/// ListParts requests you can include the part-number-marker query string
/// parameter and set its value to the NextPartNumberMarker field value from
/// the previous response.
///
///
///
/// If the upload was created using a checksum algorithm, you will need to have permission
/// to the kms:Decrypt action for the request to succeed.
///
///
///
/// For more information on multipart uploads, see Uploading
/// Objects Using Multipart Upload.
///
///
///
/// For information on permissions required to use the multipart upload API, see Multipart
/// Upload and Permissions.
///
///
///
/// The following operations are related to ListParts:
///
///
///
/// Container for the necessary parameters to execute the ListParts service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListParts service method, as returned by S3.
/// REST API Reference for ListParts Operation
public virtual Task ListPartsAsync(ListPartsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = ListPartsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListPartsResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region ListVersions
///
/// Returns metadata about all versions of the objects in a bucket. You can also use request
/// parameters as selection criteria to return metadata about a subset of all the object
/// versions.
///
///
///
/// To use this operation, you must have permission to perform the s3:ListBucketVersions
/// action. Be aware of the name difference.
///
///
///
/// A 200 OK response can contain valid or invalid XML. Make sure to design
/// your application to parse the contents of the response and handle it appropriately.
///
///
///
/// To use this operation, you must have READ access to the bucket.
///
///
///
/// This action is not supported by Amazon S3 on Outposts.
///
///
///
/// The following operations are related to ListObjectVersions:
///
///
///
/// The bucket name that contains the objects.
///
/// The response from the ListVersions service method, as returned by S3.
/// REST API Reference for ListVersions Operation
public virtual ListVersionsResponse ListVersions(string bucketName)
{
var request = new ListVersionsRequest();
request.BucketName = bucketName;
return ListVersions(request);
}
///
/// Returns metadata about all versions of the objects in a bucket. You can also use request
/// parameters as selection criteria to return metadata about a subset of all the object
/// versions.
///
///
///
/// To use this operation, you must have permission to perform the s3:ListBucketVersions
/// action. Be aware of the name difference.
///
///
///
/// A 200 OK response can contain valid or invalid XML. Make sure to design
/// your application to parse the contents of the response and handle it appropriately.
///
///
///
/// To use this operation, you must have READ access to the bucket.
///
///
///
/// This action is not supported by Amazon S3 on Outposts.
///
///
///
/// The following operations are related to ListObjectVersions:
///
///
///
/// The bucket name that contains the objects.
/// 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 prefix to make groups in the same way that you'd use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes.
///
/// The response from the ListVersions service method, as returned by S3.
/// REST API Reference for ListVersions Operation
public virtual ListVersionsResponse ListVersions(string bucketName, string prefix)
{
var request = new ListVersionsRequest();
request.BucketName = bucketName;
request.Prefix = prefix;
return ListVersions(request);
}
///
/// Returns metadata about all versions of the objects in a bucket. You can also use request
/// parameters as selection criteria to return metadata about a subset of all the object
/// versions.
///
///
///
/// To use this operation, you must have permission to perform the s3:ListBucketVersions
/// action. Be aware of the name difference.
///
///
///
/// A 200 OK response can contain valid or invalid XML. Make sure to design
/// your application to parse the contents of the response and handle it appropriately.
///
///
///
/// To use this operation, you must have READ access to the bucket.
///
///
///
/// This action is not supported by Amazon S3 on Outposts.
///
///
///
/// The following operations are related to ListObjectVersions:
///
///
///
/// Container for the necessary parameters to execute the ListVersions service method.
///
/// The response from the ListVersions service method, as returned by S3.
/// REST API Reference for ListVersions Operation
public virtual ListVersionsResponse ListVersions(ListVersionsRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListVersionsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListVersionsResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Returns metadata about all versions of the objects in a bucket. You can also use request
/// parameters as selection criteria to return metadata about a subset of all the object
/// versions.
///
///
///
/// To use this operation, you must have permission to perform the s3:ListBucketVersions
/// action. Be aware of the name difference.
///
///
///
/// A 200 OK response can contain valid or invalid XML. Make sure to design
/// your application to parse the contents of the response and handle it appropriately.
///
///
///
/// To use this operation, you must have READ access to the bucket.
///
///
///
/// This action is not supported by Amazon S3 on Outposts.
///
///
///
/// The following operations are related to ListObjectVersions:
///
///
///
/// The bucket name that contains the objects.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListVersions service method, as returned by S3.
/// REST API Reference for ListVersions Operation
public virtual Task ListVersionsAsync(string bucketName, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var request = new ListVersionsRequest();
request.BucketName = bucketName;
return ListVersionsAsync(request, cancellationToken);
}
///
/// Returns metadata about all versions of the objects in a bucket. You can also use request
/// parameters as selection criteria to return metadata about a subset of all the object
/// versions.
///
///
///
/// To use this operation, you must have permission to perform the s3:ListBucketVersions
/// action. Be aware of the name difference.
///
///
///
/// A 200 OK response can contain valid or invalid XML. Make sure to design
/// your application to parse the contents of the response and handle it appropriately.
///
///
///
/// To use this operation, you must have READ access to the bucket.
///
///
///
/// This action is not supported by Amazon S3 on Outposts.
///
///
///
/// The following operations are related to ListObjectVersions:
///
///
///
/// The bucket name that contains the objects.
/// 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 prefix to make groups in the same way that you'd use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListVersions service method, as returned by S3.
/// REST API Reference for ListVersions Operation
public virtual Task ListVersionsAsync(string bucketName, string prefix, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var request = new ListVersionsRequest();
request.BucketName = bucketName;
request.Prefix = prefix;
return ListVersionsAsync(request, cancellationToken);
}
///
/// Returns metadata about all versions of the objects in a bucket. You can also use request
/// parameters as selection criteria to return metadata about a subset of all the object
/// versions.
///
///
///
/// To use this operation, you must have permission to perform the s3:ListBucketVersions
/// action. Be aware of the name difference.
///
///
///
/// A 200 OK response can contain valid or invalid XML. Make sure to design
/// your application to parse the contents of the response and handle it appropriately.
///
///
///
/// To use this operation, you must have READ access to the bucket.
///
///
///
/// This action is not supported by Amazon S3 on Outposts.
///
///
///
/// The following operations are related to ListObjectVersions:
///
///
///
/// Container for the necessary parameters to execute the ListVersions service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListVersions service method, as returned by S3.
/// REST API Reference for ListVersions Operation
public virtual Task ListVersionsAsync(ListVersionsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = ListVersionsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListVersionsResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region PutACL
///
/// Sets the permissions on an existing bucket using access control lists (ACL). For more
/// information, see Using
/// ACLs. To set the ACL of a bucket, you must have WRITE_ACP permission.
///
///
///
/// You can use one of the following two ways to set a bucket's permissions:
///
/// -
///
/// Specify the ACL in the request body
///
///
-
///
/// Specify permissions using request headers
///
///
///
/// You cannot specify access permission using both the body and the request headers.
///
///
///
/// Depending on your application needs, you may choose to set the ACL on a bucket using
/// either the request body or the headers. For example, if you have an existing application
/// that updates a bucket ACL using the request body, then you can continue to use that
/// approach.
///
///
///
/// If your bucket uses the bucket owner enforced setting for S3 Object Ownership, ACLs
/// are disabled and no longer affect permissions. You must use policies to grant access
/// to your bucket and the objects in it. Requests to set ACLs or update ACLs fail and
/// return the AccessControlListNotSupported error code. Requests to read
/// ACLs are still supported. For more information, see Controlling
/// object ownership in the Amazon S3 User Guide.
///
/// - Permissions
-
///
/// You can set access permissions by using one of the following methods:
///
///
-
///
/// Specify a canned ACL with the
x-amz-acl request header. Amazon S3 supports
/// a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined
/// set of grantees and permissions. Specify the canned ACL name as the value of x-amz-acl.
/// If you use this header, you cannot use other access control-specific headers in your
/// request. For more information, see Canned
/// ACL.
///
/// -
///
/// Specify access permissions explicitly with the
x-amz-grant-read, x-amz-grant-read-acp,
/// x-amz-grant-write-acp, and x-amz-grant-full-control headers.
/// When using these headers, you specify explicit access permissions and grantees (Amazon
/// Web Services accounts or Amazon S3 groups) who will receive the permission. If you
/// use these ACL-specific headers, you cannot use the x-amz-acl header to
/// set a canned ACL. These parameters map to the set of permissions that Amazon S3 supports
/// in an ACL. For more information, see Access
/// Control List (ACL) Overview.
///
///
///
/// You specify each grantee as a type=value pair, where the type is one of the following:
///
/// -
///
///
id – if the value specified is the canonical user ID of an Amazon Web
/// Services account
///
/// -
///
///
uri – if you are granting permissions to a predefined group
///
/// -
///
///
emailAddress – if the value specified is the email address of an Amazon
/// Web Services account
///
///
///
/// Using email addresses to specify a grantee is only supported in the following Amazon
/// Web Services Regions:
///
/// -
///
/// US East (N. Virginia)
///
///
-
///
/// US West (N. California)
///
///
-
///
/// US West (Oregon)
///
///
-
///
/// Asia Pacific (Singapore)
///
///
-
///
/// Asia Pacific (Sydney)
///
///
-
///
/// Asia Pacific (Tokyo)
///
///
-
///
/// Europe (Ireland)
///
///
-
///
/// South America (São Paulo)
///
///
///
/// For a list of all the Amazon S3 supported Regions and endpoints, see Regions
/// and Endpoints in the Amazon Web Services General Reference.
///
///
///
/// For example, the following x-amz-grant-write header grants create, overwrite,
/// and delete objects permission to LogDelivery group predefined by Amazon S3 and two
/// Amazon Web Services accounts identified by their email addresses.
///
///
///
/// x-amz-grant-write: uri="http://acs.amazonaws.com/groups/s3/LogDelivery", id="111122223333",
/// id="555566667777"
///
///
///
/// You can use either a canned ACL or specify access permissions explicitly. You cannot
/// do both.
///
/// - Grantee Values
-
///
/// You can specify the person (grantee) to whom you're assigning access rights (using
/// request elements) in the following ways:
///
///
-
///
/// By the person's ID:
///
///
///
///
<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName>
/// </Grantee>
///
///
///
/// DisplayName is optional and ignored in the request
///
/// -
///
/// By URI:
///
///
///
///
<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee>
///
///
/// -
///
/// By Email address:
///
///
///
///
<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress>&</Grantee>
///
///
///
///
/// The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl
/// request, appears as the CanonicalUser.
///
///
///
/// Using email addresses to specify a grantee is only supported in the following Amazon
/// Web Services Regions:
///
/// -
///
/// US East (N. Virginia)
///
///
-
///
/// US West (N. California)
///
///
-
///
/// US West (Oregon)
///
///
-
///
/// Asia Pacific (Singapore)
///
///
-
///
/// Asia Pacific (Sydney)
///
///
-
///
/// Asia Pacific (Tokyo)
///
///
-
///
/// Europe (Ireland)
///
///
-
///
/// South America (São Paulo)
///
///
///
/// For a list of all the Amazon S3 supported Regions and endpoints, see Regions
/// and Endpoints in the Amazon Web Services General Reference.
///
///
///
/// The following operations are related to PutBucketAcl:
///
///
///
/// Container for the necessary parameters to execute the PutACL service method.
///
/// The response from the PutACL service method, as returned by S3.
/// REST API Reference for PutACL Operation
public virtual PutACLResponse PutACL(PutACLRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = PutACLRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutACLResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Sets the permissions on an existing bucket using access control lists (ACL). For more
/// information, see Using
/// ACLs. To set the ACL of a bucket, you must have WRITE_ACP permission.
///
///
///
/// You can use one of the following two ways to set a bucket's permissions:
///
/// -
///
/// Specify the ACL in the request body
///
///
-
///
/// Specify permissions using request headers
///
///
///
/// You cannot specify access permission using both the body and the request headers.
///
///
///
/// Depending on your application needs, you may choose to set the ACL on a bucket using
/// either the request body or the headers. For example, if you have an existing application
/// that updates a bucket ACL using the request body, then you can continue to use that
/// approach.
///
///
///
/// If your bucket uses the bucket owner enforced setting for S3 Object Ownership, ACLs
/// are disabled and no longer affect permissions. You must use policies to grant access
/// to your bucket and the objects in it. Requests to set ACLs or update ACLs fail and
/// return the AccessControlListNotSupported error code. Requests to read
/// ACLs are still supported. For more information, see Controlling
/// object ownership in the Amazon S3 User Guide.
///
/// - Permissions
-
///
/// You can set access permissions by using one of the following methods:
///
///
-
///
/// Specify a canned ACL with the
x-amz-acl request header. Amazon S3 supports
/// a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined
/// set of grantees and permissions. Specify the canned ACL name as the value of x-amz-acl.
/// If you use this header, you cannot use other access control-specific headers in your
/// request. For more information, see Canned
/// ACL.
///
/// -
///
/// Specify access permissions explicitly with the
x-amz-grant-read, x-amz-grant-read-acp,
/// x-amz-grant-write-acp, and x-amz-grant-full-control headers.
/// When using these headers, you specify explicit access permissions and grantees (Amazon
/// Web Services accounts or Amazon S3 groups) who will receive the permission. If you
/// use these ACL-specific headers, you cannot use the x-amz-acl header to
/// set a canned ACL. These parameters map to the set of permissions that Amazon S3 supports
/// in an ACL. For more information, see Access
/// Control List (ACL) Overview.
///
///
///
/// You specify each grantee as a type=value pair, where the type is one of the following:
///
/// -
///
///
id – if the value specified is the canonical user ID of an Amazon Web
/// Services account
///
/// -
///
///
uri – if you are granting permissions to a predefined group
///
/// -
///
///
emailAddress – if the value specified is the email address of an Amazon
/// Web Services account
///
///
///
/// Using email addresses to specify a grantee is only supported in the following Amazon
/// Web Services Regions:
///
/// -
///
/// US East (N. Virginia)
///
///
-
///
/// US West (N. California)
///
///
-
///
/// US West (Oregon)
///
///
-
///
/// Asia Pacific (Singapore)
///
///
-
///
/// Asia Pacific (Sydney)
///
///
-
///
/// Asia Pacific (Tokyo)
///
///
-
///
/// Europe (Ireland)
///
///
-
///
/// South America (São Paulo)
///
///
///
/// For a list of all the Amazon S3 supported Regions and endpoints, see Regions
/// and Endpoints in the Amazon Web Services General Reference.
///
///
///
/// For example, the following x-amz-grant-write header grants create, overwrite,
/// and delete objects permission to LogDelivery group predefined by Amazon S3 and two
/// Amazon Web Services accounts identified by their email addresses.
///
///
///
/// x-amz-grant-write: uri="http://acs.amazonaws.com/groups/s3/LogDelivery", id="111122223333",
/// id="555566667777"
///
///
///
/// You can use either a canned ACL or specify access permissions explicitly. You cannot
/// do both.
///
/// - Grantee Values
-
///
/// You can specify the person (grantee) to whom you're assigning access rights (using
/// request elements) in the following ways:
///
///
-
///
/// By the person's ID:
///
///
///
///
<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName>
/// </Grantee>
///
///
///
/// DisplayName is optional and ignored in the request
///
/// -
///
/// By URI:
///
///
///
///
<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee>
///
///
/// -
///
/// By Email address:
///
///
///
///
<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress>&</Grantee>
///
///
///
///
/// The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl
/// request, appears as the CanonicalUser.
///
///
///
/// Using email addresses to specify a grantee is only supported in the following Amazon
/// Web Services Regions:
///
/// -
///
/// US East (N. Virginia)
///
///
-
///
/// US West (N. California)
///
///
-
///
/// US West (Oregon)
///
///
-
///
/// Asia Pacific (Singapore)
///
///
-
///
/// Asia Pacific (Sydney)
///
///
-
///
/// Asia Pacific (Tokyo)
///
///
-
///
/// Europe (Ireland)
///
///
-
///
/// South America (São Paulo)
///
///
///
/// For a list of all the Amazon S3 supported Regions and endpoints, see Regions
/// and Endpoints in the Amazon Web Services General Reference.
///
///
///
/// The following operations are related to PutBucketAcl:
///
///
///
/// Container for the necessary parameters to execute the PutACL service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the PutACL service method, as returned by S3.
/// REST API Reference for PutACL Operation
public virtual Task PutACLAsync(PutACLRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = PutACLRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutACLResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region PutBucket
///
/// Creates a new S3 bucket. To create a bucket, you must register with Amazon S3 and
/// have a valid Amazon Web Services Access Key ID to authenticate requests. Anonymous
/// requests are never allowed to create buckets. By creating the bucket, you become the
/// bucket owner.
///
///
///
/// Not every string is an acceptable bucket name. For information about bucket naming
/// restrictions, see Bucket
/// naming rules.
///
///
///
/// If you want to create an Amazon S3 on Outposts bucket, see Create
/// Bucket.
///
///
///
/// By default, the bucket is created in the US East (N. Virginia) Region. You can optionally
/// specify a Region in the request body. To constrain the bucket creation to a specific
/// Region, you can use
/// LocationConstraint condition key. You might choose a Region to optimize
/// latency, minimize costs, or address regulatory requirements. For example, if you reside
/// in Europe, you will probably find it advantageous to create buckets in the Europe
/// (Ireland) Region. For more information, see Accessing
/// a bucket.
///
///
///
/// If you send your create bucket request to the s3.amazonaws.com endpoint,
/// the request goes to the us-east-1 Region. Accordingly, the signature
/// calculations in Signature Version 4 must use us-east-1 as the Region,
/// even if the location constraint in the request specifies another Region where the
/// bucket is to be created. If you create a bucket in a Region other than US East (N.
/// Virginia), your application must be able to handle 307 redirect. For more information,
/// see Virtual
/// hosting of buckets.
///
/// - Permissions
-
///
/// In addition to
s3:CreateBucket, the following permissions are required
/// when your CreateBucket request includes specific headers:
///
/// -
///
/// Access control lists (ACLs) - If your
CreateBucket 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 s3:CreateBucket and s3:PutBucketAcl permissions
/// are needed. If the ACL for the CreateBucket request is private or if
/// the request doesn't specify any ACLs, only s3:CreateBucket permission
/// is needed.
///
/// -
///
/// Object Lock - If
ObjectLockEnabledForBucket is set to true in
/// your CreateBucket request, s3:PutBucketObjectLockConfiguration
/// and s3:PutBucketVersioning permissions are required.
///
/// -
///
/// S3 Object Ownership - If your
CreateBucket request includes the
/// x-amz-object-ownership header, then the s3:PutBucketOwnershipControls
/// permission is required. By default, ObjectOwnership is set to BucketOWnerEnforced
/// 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 ObjectOwnership setting, you can use the x-amz-object-ownership
/// header in your CreateBucket request to set the ObjectOwnership
/// setting of your choice. For more information about S3 Object Ownership, see Controlling
/// object ownership in the Amazon S3 User Guide.
///
/// -
///
/// S3 Block Public Access - 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
///
DeletePublicAccessBlock API. To use this operation, you must have
/// the s3:PutBucketPublicAccessBlock 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 Blocking
/// public access to your Amazon S3 storage in the Amazon S3 User Guide.
///
///
///
/// If your CreateBucket request sets BucketOwnerEnforced 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 400 error and
/// returns the InvalidBucketAcLWithObjectOwnership error code. For more
/// information, see Setting
/// Object Ownership on an existing bucket in the Amazon S3 User Guide.
///
///
///
/// The following operations are related to CreateBucket:
///
///
///
/// The name of the bucket to create.
///
/// The response from the PutBucket service method, as returned by S3.
/// REST API Reference for PutBucket Operation
public virtual PutBucketResponse PutBucket(string bucketName)
{
var request = new PutBucketRequest();
request.BucketName = bucketName;
return PutBucket(request);
}
///
/// Creates a new S3 bucket. To create a bucket, you must register with Amazon S3 and
/// have a valid Amazon Web Services Access Key ID to authenticate requests. Anonymous
/// requests are never allowed to create buckets. By creating the bucket, you become the
/// bucket owner.
///
///
///
/// Not every string is an acceptable bucket name. For information about bucket naming
/// restrictions, see Bucket
/// naming rules.
///
///
///
/// If you want to create an Amazon S3 on Outposts bucket, see Create
/// Bucket.
///
///
///
/// By default, the bucket is created in the US East (N. Virginia) Region. You can optionally
/// specify a Region in the request body. To constrain the bucket creation to a specific
/// Region, you can use
/// LocationConstraint condition key. You might choose a Region to optimize
/// latency, minimize costs, or address regulatory requirements. For example, if you reside
/// in Europe, you will probably find it advantageous to create buckets in the Europe
/// (Ireland) Region. For more information, see Accessing
/// a bucket.
///
///
///
/// If you send your create bucket request to the s3.amazonaws.com endpoint,
/// the request goes to the us-east-1 Region. Accordingly, the signature
/// calculations in Signature Version 4 must use us-east-1 as the Region,
/// even if the location constraint in the request specifies another Region where the
/// bucket is to be created. If you create a bucket in a Region other than US East (N.
/// Virginia), your application must be able to handle 307 redirect. For more information,
/// see Virtual
/// hosting of buckets.
///
/// - Permissions
-
///
/// In addition to
s3:CreateBucket, the following permissions are required
/// when your CreateBucket request includes specific headers:
///
/// -
///
/// Access control lists (ACLs) - If your
CreateBucket 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 s3:CreateBucket and s3:PutBucketAcl permissions
/// are needed. If the ACL for the CreateBucket request is private or if
/// the request doesn't specify any ACLs, only s3:CreateBucket permission
/// is needed.
///
/// -
///
/// Object Lock - If
ObjectLockEnabledForBucket is set to true in
/// your CreateBucket request, s3:PutBucketObjectLockConfiguration
/// and s3:PutBucketVersioning permissions are required.
///
/// -
///
/// S3 Object Ownership - If your
CreateBucket request includes the
/// x-amz-object-ownership header, then the s3:PutBucketOwnershipControls
/// permission is required. By default, ObjectOwnership is set to BucketOWnerEnforced
/// 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 ObjectOwnership setting, you can use the x-amz-object-ownership
/// header in your CreateBucket request to set the ObjectOwnership
/// setting of your choice. For more information about S3 Object Ownership, see Controlling
/// object ownership in the Amazon S3 User Guide.
///
/// -
///
/// S3 Block Public Access - 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
///
DeletePublicAccessBlock API. To use this operation, you must have
/// the s3:PutBucketPublicAccessBlock 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 Blocking
/// public access to your Amazon S3 storage in the Amazon S3 User Guide.
///
///
///
/// If your CreateBucket request sets BucketOwnerEnforced 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 400 error and
/// returns the InvalidBucketAcLWithObjectOwnership error code. For more
/// information, see Setting
/// Object Ownership on an existing bucket in the Amazon S3 User Guide.
///
///
///
/// The following operations are related to CreateBucket:
///
///
///
/// Container for the necessary parameters to execute the PutBucket service method.
///
/// The response from the PutBucket service method, as returned by S3.
/// REST API Reference for PutBucket Operation
public virtual PutBucketResponse PutBucket(PutBucketRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = PutBucketRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutBucketResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Creates a new S3 bucket. To create a bucket, you must register with Amazon S3 and
/// have a valid Amazon Web Services Access Key ID to authenticate requests. Anonymous
/// requests are never allowed to create buckets. By creating the bucket, you become the
/// bucket owner.
///
///
///
/// Not every string is an acceptable bucket name. For information about bucket naming
/// restrictions, see Bucket
/// naming rules.
///
///
///
/// If you want to create an Amazon S3 on Outposts bucket, see Create
/// Bucket.
///
///
///
/// By default, the bucket is created in the US East (N. Virginia) Region. You can optionally
/// specify a Region in the request body. To constrain the bucket creation to a specific
/// Region, you can use
/// LocationConstraint condition key. You might choose a Region to optimize
/// latency, minimize costs, or address regulatory requirements. For example, if you reside
/// in Europe, you will probably find it advantageous to create buckets in the Europe
/// (Ireland) Region. For more information, see Accessing
/// a bucket.
///
///
///
/// If you send your create bucket request to the s3.amazonaws.com endpoint,
/// the request goes to the us-east-1 Region. Accordingly, the signature
/// calculations in Signature Version 4 must use us-east-1 as the Region,
/// even if the location constraint in the request specifies another Region where the
/// bucket is to be created. If you create a bucket in a Region other than US East (N.
/// Virginia), your application must be able to handle 307 redirect. For more information,
/// see Virtual
/// hosting of buckets.
///
/// - Permissions
-
///
/// In addition to
s3:CreateBucket, the following permissions are required
/// when your CreateBucket request includes specific headers:
///
/// -
///
/// Access control lists (ACLs) - If your
CreateBucket 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 s3:CreateBucket and s3:PutBucketAcl permissions
/// are needed. If the ACL for the CreateBucket request is private or if
/// the request doesn't specify any ACLs, only s3:CreateBucket permission
/// is needed.
///
/// -
///
/// Object Lock - If
ObjectLockEnabledForBucket is set to true in
/// your CreateBucket request, s3:PutBucketObjectLockConfiguration
/// and s3:PutBucketVersioning permissions are required.
///
/// -
///
/// S3 Object Ownership - If your
CreateBucket request includes the
/// x-amz-object-ownership header, then the s3:PutBucketOwnershipControls
/// permission is required. By default, ObjectOwnership is set to BucketOWnerEnforced
/// 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 ObjectOwnership setting, you can use the x-amz-object-ownership
/// header in your CreateBucket request to set the ObjectOwnership
/// setting of your choice. For more information about S3 Object Ownership, see Controlling
/// object ownership in the Amazon S3 User Guide.
///
/// -
///
/// S3 Block Public Access - 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
///
DeletePublicAccessBlock API. To use this operation, you must have
/// the s3:PutBucketPublicAccessBlock 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 Blocking
/// public access to your Amazon S3 storage in the Amazon S3 User Guide.
///
///
///
/// If your CreateBucket request sets BucketOwnerEnforced 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 400 error and
/// returns the InvalidBucketAcLWithObjectOwnership error code. For more
/// information, see Setting
/// Object Ownership on an existing bucket in the Amazon S3 User Guide.
///
///
///
/// The following operations are related to CreateBucket:
///
///
///
/// The name of the bucket to create.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the PutBucket service method, as returned by S3.
/// REST API Reference for PutBucket Operation
public virtual Task PutBucketAsync(string bucketName, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var request = new PutBucketRequest();
request.BucketName = bucketName;
return PutBucketAsync(request, cancellationToken);
}
///
/// Creates a new S3 bucket. To create a bucket, you must register with Amazon S3 and
/// have a valid Amazon Web Services Access Key ID to authenticate requests. Anonymous
/// requests are never allowed to create buckets. By creating the bucket, you become the
/// bucket owner.
///
///
///
/// Not every string is an acceptable bucket name. For information about bucket naming
/// restrictions, see Bucket
/// naming rules.
///
///
///
/// If you want to create an Amazon S3 on Outposts bucket, see Create
/// Bucket.
///
///
///
/// By default, the bucket is created in the US East (N. Virginia) Region. You can optionally
/// specify a Region in the request body. To constrain the bucket creation to a specific
/// Region, you can use
/// LocationConstraint condition key. You might choose a Region to optimize
/// latency, minimize costs, or address regulatory requirements. For example, if you reside
/// in Europe, you will probably find it advantageous to create buckets in the Europe
/// (Ireland) Region. For more information, see Accessing
/// a bucket.
///
///
///
/// If you send your create bucket request to the s3.amazonaws.com endpoint,
/// the request goes to the us-east-1 Region. Accordingly, the signature
/// calculations in Signature Version 4 must use us-east-1 as the Region,
/// even if the location constraint in the request specifies another Region where the
/// bucket is to be created. If you create a bucket in a Region other than US East (N.
/// Virginia), your application must be able to handle 307 redirect. For more information,
/// see Virtual
/// hosting of buckets.
///
/// - Permissions
-
///
/// In addition to
s3:CreateBucket, the following permissions are required
/// when your CreateBucket request includes specific headers:
///
/// -
///
/// Access control lists (ACLs) - If your
CreateBucket 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 s3:CreateBucket and s3:PutBucketAcl permissions
/// are needed. If the ACL for the CreateBucket request is private or if
/// the request doesn't specify any ACLs, only s3:CreateBucket permission
/// is needed.
///
/// -
///
/// Object Lock - If
ObjectLockEnabledForBucket is set to true in
/// your CreateBucket request, s3:PutBucketObjectLockConfiguration
/// and s3:PutBucketVersioning permissions are required.
///
/// -
///
/// S3 Object Ownership - If your
CreateBucket request includes the
/// x-amz-object-ownership header, then the s3:PutBucketOwnershipControls
/// permission is required. By default, ObjectOwnership is set to BucketOWnerEnforced
/// 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 ObjectOwnership setting, you can use the x-amz-object-ownership
/// header in your CreateBucket request to set the ObjectOwnership
/// setting of your choice. For more information about S3 Object Ownership, see Controlling
/// object ownership in the Amazon S3 User Guide.
///
/// -
///
/// S3 Block Public Access - 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
///
DeletePublicAccessBlock API. To use this operation, you must have
/// the s3:PutBucketPublicAccessBlock 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 Blocking
/// public access to your Amazon S3 storage in the Amazon S3 User Guide.
///
///
///
/// If your CreateBucket request sets BucketOwnerEnforced 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 400 error and
/// returns the InvalidBucketAcLWithObjectOwnership error code. For more
/// information, see Setting
/// Object Ownership on an existing bucket in the Amazon S3 User Guide.
///
///
///
/// The following operations are related to CreateBucket:
///
///
///
/// Container for the necessary parameters to execute the PutBucket service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the PutBucket service method, as returned by S3.
/// REST API Reference for PutBucket Operation
public virtual Task PutBucketAsync(PutBucketRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = PutBucketRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutBucketResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region PutBucketAccelerateConfiguration
///
/// Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration
/// is a bucket-level feature that enables you to perform faster data transfers to Amazon
/// S3.
///
///
///
/// To use this operation, you must have permission to perform the s3:PutAccelerateConfiguration
/// action. The bucket owner has this permission by default. The bucket owner can grant
/// this permission to others. For more information about permissions, see Permissions
/// Related to Bucket Subresource Operations and Managing
/// Access Permissions to Your Amazon S3 Resources.
///
///
///
/// The Transfer Acceleration state of a bucket can be set to one of the following two
/// values:
///
/// -
///
/// Enabled – Enables accelerated data transfers to the bucket.
///
///
-
///
/// Suspended – Disables accelerated data transfers to the bucket.
///
///
///
/// The GetBucketAccelerateConfiguration
/// action returns the transfer acceleration state of a bucket.
///
///
///
/// After setting the Transfer Acceleration state of a bucket to Enabled, it might take
/// up to thirty minutes before the data transfer rates to the bucket increase.
///
///
///
/// The name of the bucket used for Transfer Acceleration must be DNS-compliant and must
/// not contain periods (".").
///
///
///
/// For more information about transfer acceleration, see Transfer
/// Acceleration.
///
///
///
/// The following operations are related to PutBucketAccelerateConfiguration:
///
///
///
/// Container for the necessary parameters to execute the PutBucketAccelerateConfiguration service method.
///
/// The response from the PutBucketAccelerateConfiguration service method, as returned by S3.
/// REST API Reference for PutBucketAccelerateConfiguration Operation
public virtual PutBucketAccelerateConfigurationResponse PutBucketAccelerateConfiguration(PutBucketAccelerateConfigurationRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = PutBucketAccelerateConfigurationRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutBucketAccelerateConfigurationResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration
/// is a bucket-level feature that enables you to perform faster data transfers to Amazon
/// S3.
///
///
///
/// To use this operation, you must have permission to perform the s3:PutAccelerateConfiguration
/// action. The bucket owner has this permission by default. The bucket owner can grant
/// this permission to others. For more information about permissions, see Permissions
/// Related to Bucket Subresource Operations and Managing
/// Access Permissions to Your Amazon S3 Resources.
///
///
///
/// The Transfer Acceleration state of a bucket can be set to one of the following two
/// values:
///
/// -
///
/// Enabled – Enables accelerated data transfers to the bucket.
///
///
-
///
/// Suspended – Disables accelerated data transfers to the bucket.
///
///
///
/// The GetBucketAccelerateConfiguration
/// action returns the transfer acceleration state of a bucket.
///
///
///
/// After setting the Transfer Acceleration state of a bucket to Enabled, it might take
/// up to thirty minutes before the data transfer rates to the bucket increase.
///
///
///
/// The name of the bucket used for Transfer Acceleration must be DNS-compliant and must
/// not contain periods (".").
///
///
///
/// For more information about transfer acceleration, see Transfer
/// Acceleration.
///
///
///
/// The following operations are related to PutBucketAccelerateConfiguration:
///
///
///
/// Container for the necessary parameters to execute the PutBucketAccelerateConfiguration service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the PutBucketAccelerateConfiguration service method, as returned by S3.
/// REST API Reference for PutBucketAccelerateConfiguration Operation
public virtual Task PutBucketAccelerateConfigurationAsync(PutBucketAccelerateConfigurationRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = PutBucketAccelerateConfigurationRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutBucketAccelerateConfigurationResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region PutBucketAnalyticsConfiguration
///
/// Sets an analytics configuration for the bucket (specified by the analytics configuration
/// ID). You can have up to 1,000 analytics configurations per bucket.
///
///
///
/// You can choose to have storage class analysis export analysis reports sent to a comma-separated
/// values (CSV) flat file. See the DataExport request element. Reports are
/// updated daily and are based on the object filters that you configure. When selecting
/// data export, you specify a destination bucket and an optional destination prefix where
/// the file is written. You can export the data to a destination bucket in a different
/// account. However, the destination bucket must be in the same Region as the bucket
/// that you are making the PUT analytics configuration to. For more information, see
/// Amazon
/// S3 Analytics – Storage Class Analysis.
///
///
///
/// You must create a bucket policy on the destination bucket where the exported file
/// is written to grant permissions to Amazon S3 to write objects to the bucket. For an
/// example policy, see Granting
/// Permissions for Amazon S3 Inventory and Storage Class Analysis.
///
///
///
/// To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration
/// action. The bucket owner has this permission by default. The bucket owner can grant
/// this permission to others. For more information about permissions, see Permissions
/// Related to Bucket Subresource Operations and Managing
/// Access Permissions to Your Amazon S3 Resources.
///
///
///
/// PutBucketAnalyticsConfiguration has the following special errors:
///
/// -
-
///
/// HTTP Error: HTTP 400 Bad Request
///
///
-
///
/// Code: InvalidArgument
///
///
-
///
/// Cause: Invalid argument.
///
///
-
-
///
/// HTTP Error: HTTP 400 Bad Request
///
///
-
///
/// Code: TooManyConfigurations
///
///
-
///
/// Cause: You are attempting to create a new configuration but have already reached
/// the 1,000-configuration limit.
///
///
-
-
///
/// HTTP Error: HTTP 403 Forbidden
///
///
-
///
/// Code: AccessDenied
///
///
-
///
/// Cause: You are not the owner of the specified bucket, or you do not have the s3:PutAnalyticsConfiguration
/// bucket permission to set the configuration on the bucket.
///
///
///
/// The following operations are related to PutBucketAnalyticsConfiguration:
///
///
///
/// Container for the necessary parameters to execute the PutBucketAnalyticsConfiguration service method.
///
/// The response from the PutBucketAnalyticsConfiguration service method, as returned by S3.
/// REST API Reference for PutBucketAnalyticsConfiguration Operation
public virtual PutBucketAnalyticsConfigurationResponse PutBucketAnalyticsConfiguration(PutBucketAnalyticsConfigurationRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = PutBucketAnalyticsConfigurationRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutBucketAnalyticsConfigurationResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Sets an analytics configuration for the bucket (specified by the analytics configuration
/// ID). You can have up to 1,000 analytics configurations per bucket.
///
///
///
/// You can choose to have storage class analysis export analysis reports sent to a comma-separated
/// values (CSV) flat file. See the DataExport request element. Reports are
/// updated daily and are based on the object filters that you configure. When selecting
/// data export, you specify a destination bucket and an optional destination prefix where
/// the file is written. You can export the data to a destination bucket in a different
/// account. However, the destination bucket must be in the same Region as the bucket
/// that you are making the PUT analytics configuration to. For more information, see
/// Amazon
/// S3 Analytics – Storage Class Analysis.
///
///
///
/// You must create a bucket policy on the destination bucket where the exported file
/// is written to grant permissions to Amazon S3 to write objects to the bucket. For an
/// example policy, see Granting
/// Permissions for Amazon S3 Inventory and Storage Class Analysis.
///
///
///
/// To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration
/// action. The bucket owner has this permission by default. The bucket owner can grant
/// this permission to others. For more information about permissions, see Permissions
/// Related to Bucket Subresource Operations and Managing
/// Access Permissions to Your Amazon S3 Resources.
///
///
///
/// PutBucketAnalyticsConfiguration has the following special errors:
///
/// -
-
///
/// HTTP Error: HTTP 400 Bad Request
///
///
-
///
/// Code: InvalidArgument
///
///
-
///
/// Cause: Invalid argument.
///
///
-
-
///
/// HTTP Error: HTTP 400 Bad Request
///
///
-
///
/// Code: TooManyConfigurations
///
///
-
///
/// Cause: You are attempting to create a new configuration but have already reached
/// the 1,000-configuration limit.
///
///
-
-
///
/// HTTP Error: HTTP 403 Forbidden
///
///
-
///
/// Code: AccessDenied
///
///
-
///
/// Cause: You are not the owner of the specified bucket, or you do not have the s3:PutAnalyticsConfiguration
/// bucket permission to set the configuration on the bucket.
///
///
///
/// The following operations are related to PutBucketAnalyticsConfiguration:
///
///
///
/// Container for the necessary parameters to execute the PutBucketAnalyticsConfiguration service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the PutBucketAnalyticsConfiguration service method, as returned by S3.
/// REST API Reference for PutBucketAnalyticsConfiguration Operation
public virtual Task PutBucketAnalyticsConfigurationAsync(PutBucketAnalyticsConfigurationRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = PutBucketAnalyticsConfigurationRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutBucketAnalyticsConfigurationResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region PutBucketEncryption
///
/// This action uses the encryption subresource to configure default encryption
/// and Amazon S3 Bucket Keys for an existing bucket.
///
///
///
/// By default, all buckets have a default encryption configuration that uses server-side
/// encryption with Amazon S3 managed keys (SSE-S3). You can optionally configure default
/// encryption for a bucket by using server-side encryption with Key Management Service
/// (KMS) keys (SSE-KMS) or dual-layer server-side encryption with Amazon Web Services
/// KMS keys (DSSE-KMS). If you specify default encryption by using SSE-KMS, you can also
/// configure Amazon
/// S3 Bucket Keys. If you use PutBucketEncryption to set your default
/// bucket encryption to SSE-KMS, you should verify that your KMS key ID is correct.
/// Amazon S3 does not validate the KMS key ID provided in PutBucketEncryption requests.
///
///
///
/// This action requires Amazon Web Services Signature Version 4. For more information,
/// see
/// Authenticating Requests (Amazon Web Services Signature Version 4).
///
///
///
/// To use this operation, you must have permission to perform the s3:PutEncryptionConfiguration
/// action. The bucket owner has this permission by default. The bucket owner can grant
/// this permission to others. For more information about permissions, see Permissions
/// Related to Bucket Subresource Operations and Managing
/// Access Permissions to Your Amazon S3 Resources in the Amazon S3 User Guide.
///
///
///
///
/// The following operations are related to PutBucketEncryption:
///
///
///
/// Container for the necessary parameters to execute the PutBucketEncryption service method.
///
/// The response from the PutBucketEncryption service method, as returned by S3.
/// REST API Reference for PutBucketEncryption Operation
public virtual PutBucketEncryptionResponse PutBucketEncryption(PutBucketEncryptionRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = PutBucketEncryptionRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutBucketEncryptionResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// This action uses the encryption subresource to configure default encryption
/// and Amazon S3 Bucket Keys for an existing bucket.
///
///
///
/// By default, all buckets have a default encryption configuration that uses server-side
/// encryption with Amazon S3 managed keys (SSE-S3). You can optionally configure default
/// encryption for a bucket by using server-side encryption with Key Management Service
/// (KMS) keys (SSE-KMS) or dual-layer server-side encryption with Amazon Web Services
/// KMS keys (DSSE-KMS). If you specify default encryption by using SSE-KMS, you can also
/// configure Amazon
/// S3 Bucket Keys. If you use PutBucketEncryption to set your default
/// bucket encryption to SSE-KMS, you should verify that your KMS key ID is correct.
/// Amazon S3 does not validate the KMS key ID provided in PutBucketEncryption requests.
///
///
///
/// This action requires Amazon Web Services Signature Version 4. For more information,
/// see
/// Authenticating Requests (Amazon Web Services Signature Version 4).
///
///
///
/// To use this operation, you must have permission to perform the s3:PutEncryptionConfiguration
/// action. The bucket owner has this permission by default. The bucket owner can grant
/// this permission to others. For more information about permissions, see Permissions
/// Related to Bucket Subresource Operations and Managing
/// Access Permissions to Your Amazon S3 Resources in the Amazon S3 User Guide.
///
///
///
///
/// The following operations are related to PutBucketEncryption:
///
///
///
/// Container for the necessary parameters to execute the PutBucketEncryption service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the PutBucketEncryption service method, as returned by S3.
/// REST API Reference for PutBucketEncryption Operation
public virtual Task PutBucketEncryptionAsync(PutBucketEncryptionRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = PutBucketEncryptionRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutBucketEncryptionResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region PutBucketIntelligentTieringConfiguration
///
/// Puts a S3 Intelligent-Tiering configuration to the specified bucket. You can have
/// up to 1,000 S3 Intelligent-Tiering configurations per bucket.
///
///
///
/// The S3 Intelligent-Tiering storage class is designed to optimize storage costs by
/// automatically moving data to the most cost-effective storage access tier, without
/// performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic
/// cost savings in three low latency and high throughput access tiers. To get the lowest
/// storage cost on data that can be accessed in minutes to hours, you can choose to activate
/// additional archiving capabilities.
///
///
///
/// The S3 Intelligent-Tiering storage class is the ideal storage class for data with
/// unknown, changing, or unpredictable access patterns, independent of object size or
/// retention period. If the size of an object is less than 128 KB, it is not monitored
/// and not eligible for auto-tiering. Smaller objects can be stored, but they are always
/// charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.
///
///
///
/// For more information, see Storage
/// class for automatically optimizing frequently and infrequently accessed objects.
///
///
///
/// Operations related to PutBucketIntelligentTieringConfiguration include:
///
///
///