(asyncResult);
}
#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);
}
///
/// Initiates the asynchronous execution of the DeleteCORSConfiguration operation.
///
///
/// Container for the necessary parameters to execute the DeleteCORSConfiguration operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteCORSConfiguration
/// operation.
/// REST API Reference for DeleteCORSConfiguration Operation
public virtual IAsyncResult BeginDeleteCORSConfiguration(DeleteCORSConfigurationRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteCORSConfigurationRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteCORSConfigurationResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the DeleteCORSConfiguration operation.
///
///
/// The IAsyncResult returned by the call to BeginDeleteCORSConfiguration.
///
/// Returns a DeleteCORSConfigurationResult from S3.
/// REST API Reference for DeleteCORSConfiguration Operation
public virtual DeleteCORSConfigurationResponse EndDeleteCORSConfiguration(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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);
}
///
/// Initiates the asynchronous execution of the DeleteLifecycleConfiguration operation.
///
///
/// Container for the necessary parameters to execute the DeleteLifecycleConfiguration operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteLifecycleConfiguration
/// operation.
/// REST API Reference for DeleteLifecycleConfiguration Operation
public virtual IAsyncResult BeginDeleteLifecycleConfiguration(DeleteLifecycleConfigurationRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteLifecycleConfigurationRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteLifecycleConfigurationResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the DeleteLifecycleConfiguration operation.
///
///
/// The IAsyncResult returned by the call to BeginDeleteLifecycleConfiguration.
///
/// Returns a DeleteLifecycleConfigurationResult from S3.
/// REST API Reference for DeleteLifecycleConfiguration Operation
public virtual DeleteLifecycleConfigurationResponse EndDeleteLifecycleConfiguration(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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);
}
///
/// Initiates the asynchronous execution of the DeleteObject operation.
///
///
/// Container for the necessary parameters to execute the DeleteObject operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteObject
/// operation.
/// REST API Reference for DeleteObject Operation
public virtual IAsyncResult BeginDeleteObject(DeleteObjectRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteObjectRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteObjectResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the DeleteObject operation.
///
///
/// The IAsyncResult returned by the call to BeginDeleteObject.
///
/// Returns a DeleteObjectResult from S3.
/// REST API Reference for DeleteObject Operation
public virtual DeleteObjectResponse EndDeleteObject(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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);
}
///
/// Initiates the asynchronous execution of the DeleteObjects operation.
///
///
/// Container for the necessary parameters to execute the DeleteObjects operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteObjects
/// operation.
/// REST API Reference for DeleteObjects Operation
public virtual IAsyncResult BeginDeleteObjects(DeleteObjectsRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteObjectsRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteObjectsResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the DeleteObjects operation.
///
///
/// The IAsyncResult returned by the call to BeginDeleteObjects.
///
/// Returns a DeleteObjectsResult from S3.
/// REST API Reference for DeleteObjects Operation
public virtual DeleteObjectsResponse EndDeleteObjects(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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);
}
///
/// Initiates the asynchronous execution of the DeleteObjectTagging operation.
///
///
/// Container for the necessary parameters to execute the DeleteObjectTagging operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteObjectTagging
/// operation.
/// REST API Reference for DeleteObjectTagging Operation
public virtual IAsyncResult BeginDeleteObjectTagging(DeleteObjectTaggingRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteObjectTaggingRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteObjectTaggingResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the DeleteObjectTagging operation.
///
///
/// The IAsyncResult returned by the call to BeginDeleteObjectTagging.
///
/// Returns a DeleteObjectTaggingResult from S3.
/// REST API Reference for DeleteObjectTagging Operation
public virtual DeleteObjectTaggingResponse EndDeleteObjectTagging(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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);
}
///
/// Initiates the asynchronous execution of the DeletePublicAccessBlock operation.
///
///
/// Container for the necessary parameters to execute the DeletePublicAccessBlock operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeletePublicAccessBlock
/// operation.
/// REST API Reference for DeletePublicAccessBlock Operation
public virtual IAsyncResult BeginDeletePublicAccessBlock(DeletePublicAccessBlockRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeletePublicAccessBlockRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeletePublicAccessBlockResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the DeletePublicAccessBlock operation.
///
///
/// The IAsyncResult returned by the call to BeginDeletePublicAccessBlock.
///
/// Returns a DeletePublicAccessBlockResult from S3.
/// REST API Reference for DeletePublicAccessBlock Operation
public virtual DeletePublicAccessBlockResponse EndDeletePublicAccessBlock(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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);
}
///
/// Initiates the asynchronous execution of the GetACL operation.
///
///
/// Container for the necessary parameters to execute the GetACL operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetACL
/// operation.
/// REST API Reference for GetACL Operation
public virtual IAsyncResult BeginGetACL(GetACLRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetACLRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetACLResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the GetACL operation.
///
///
/// The IAsyncResult returned by the call to BeginGetACL.
///
/// Returns a GetACLResult from S3.
/// REST API Reference for GetACL Operation
public virtual GetACLResponse EndGetACL(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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);
}
///
/// Initiates the asynchronous execution of the GetBucketAccelerateConfiguration operation.
///
///
/// Container for the necessary parameters to execute the GetBucketAccelerateConfiguration operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketAccelerateConfiguration
/// operation.
/// REST API Reference for GetBucketAccelerateConfiguration Operation
public virtual IAsyncResult BeginGetBucketAccelerateConfiguration(GetBucketAccelerateConfigurationRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetBucketAccelerateConfigurationRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetBucketAccelerateConfigurationResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the GetBucketAccelerateConfiguration operation.
///
///
/// The IAsyncResult returned by the call to BeginGetBucketAccelerateConfiguration.
///
/// Returns a GetBucketAccelerateConfigurationResult from S3.
/// REST API Reference for GetBucketAccelerateConfiguration Operation
public virtual GetBucketAccelerateConfigurationResponse EndGetBucketAccelerateConfiguration(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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);
}
///
/// Initiates the asynchronous execution of the GetBucketAnalyticsConfiguration operation.
///
///
/// Container for the necessary parameters to execute the GetBucketAnalyticsConfiguration operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketAnalyticsConfiguration
/// operation.
/// REST API Reference for GetBucketAnalyticsConfiguration Operation
public virtual IAsyncResult BeginGetBucketAnalyticsConfiguration(GetBucketAnalyticsConfigurationRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetBucketAnalyticsConfigurationRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetBucketAnalyticsConfigurationResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the GetBucketAnalyticsConfiguration operation.
///
///
/// The IAsyncResult returned by the call to BeginGetBucketAnalyticsConfiguration.
///
/// Returns a GetBucketAnalyticsConfigurationResult from S3.
/// REST API Reference for GetBucketAnalyticsConfiguration Operation
public virtual GetBucketAnalyticsConfigurationResponse EndGetBucketAnalyticsConfiguration(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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);
}
///
/// Initiates the asynchronous execution of the GetBucketEncryption operation.
///
///
/// Container for the necessary parameters to execute the GetBucketEncryption operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketEncryption
/// operation.
/// REST API Reference for GetBucketEncryption Operation
public virtual IAsyncResult BeginGetBucketEncryption(GetBucketEncryptionRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetBucketEncryptionRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetBucketEncryptionResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the GetBucketEncryption operation.
///
///
/// The IAsyncResult returned by the call to BeginGetBucketEncryption.
///
/// Returns a GetBucketEncryptionResult from S3.
/// REST API Reference for GetBucketEncryption Operation
public virtual GetBucketEncryptionResponse EndGetBucketEncryption(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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);
}
///
/// Initiates the asynchronous execution of the GetBucketIntelligentTieringConfiguration operation.
///
///
/// Container for the necessary parameters to execute the GetBucketIntelligentTieringConfiguration operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketIntelligentTieringConfiguration
/// operation.
/// REST API Reference for GetBucketIntelligentTieringConfiguration Operation
public virtual IAsyncResult BeginGetBucketIntelligentTieringConfiguration(GetBucketIntelligentTieringConfigurationRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetBucketIntelligentTieringConfigurationRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetBucketIntelligentTieringConfigurationResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the GetBucketIntelligentTieringConfiguration operation.
///
///
/// The IAsyncResult returned by the call to BeginGetBucketIntelligentTieringConfiguration.
///
/// Returns a GetBucketIntelligentTieringConfigurationResult from S3.
/// REST API Reference for GetBucketIntelligentTieringConfiguration Operation
public virtual GetBucketIntelligentTieringConfigurationResponse EndGetBucketIntelligentTieringConfiguration(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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);
}
///
/// Initiates the asynchronous execution of the GetBucketInventoryConfiguration operation.
///
///
/// Container for the necessary parameters to execute the GetBucketInventoryConfiguration operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketInventoryConfiguration
/// operation.
/// REST API Reference for GetBucketInventoryConfiguration Operation
public virtual IAsyncResult BeginGetBucketInventoryConfiguration(GetBucketInventoryConfigurationRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetBucketInventoryConfigurationRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetBucketInventoryConfigurationResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the GetBucketInventoryConfiguration operation.
///
///
/// The IAsyncResult returned by the call to BeginGetBucketInventoryConfiguration.
///
/// Returns a GetBucketInventoryConfigurationResult from S3.
/// REST API Reference for GetBucketInventoryConfiguration Operation
public virtual GetBucketInventoryConfigurationResponse EndGetBucketInventoryConfiguration(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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);
}
///
/// Initiates the asynchronous execution of the GetBucketLocation operation.
///
///
/// Container for the necessary parameters to execute the GetBucketLocation operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketLocation
/// operation.
/// REST API Reference for GetBucketLocation Operation
public virtual IAsyncResult BeginGetBucketLocation(GetBucketLocationRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetBucketLocationRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetBucketLocationResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the GetBucketLocation operation.
///
///
/// The IAsyncResult returned by the call to BeginGetBucketLocation.
///
/// Returns a GetBucketLocationResult from S3.
/// REST API Reference for GetBucketLocation Operation
public virtual GetBucketLocationResponse EndGetBucketLocation(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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);
}
///
/// Initiates the asynchronous execution of the GetBucketLogging operation.
///
///
/// Container for the necessary parameters to execute the GetBucketLogging operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketLogging
/// operation.
/// REST API Reference for GetBucketLogging Operation
public virtual IAsyncResult BeginGetBucketLogging(GetBucketLoggingRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetBucketLoggingRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetBucketLoggingResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the GetBucketLogging operation.
///
///
/// The IAsyncResult returned by the call to BeginGetBucketLogging.
///
/// Returns a GetBucketLoggingResult from S3.
/// REST API Reference for GetBucketLogging Operation
public virtual GetBucketLoggingResponse EndGetBucketLogging(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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);
}
///
/// Initiates the asynchronous execution of the GetBucketMetricsConfiguration operation.
///
///
/// Container for the necessary parameters to execute the GetBucketMetricsConfiguration operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketMetricsConfiguration
/// operation.
/// REST API Reference for GetBucketMetricsConfiguration Operation
public virtual IAsyncResult BeginGetBucketMetricsConfiguration(GetBucketMetricsConfigurationRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetBucketMetricsConfigurationRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetBucketMetricsConfigurationResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the GetBucketMetricsConfiguration operation.
///
///
/// The IAsyncResult returned by the call to BeginGetBucketMetricsConfiguration.
///
/// Returns a GetBucketMetricsConfigurationResult from S3.
/// REST API Reference for GetBucketMetricsConfiguration Operation
public virtual GetBucketMetricsConfigurationResponse EndGetBucketMetricsConfiguration(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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);
}
///
/// Initiates the asynchronous execution of the GetBucketNotification operation.
///
///
/// Container for the necessary parameters to execute the GetBucketNotification operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketNotification
/// operation.
/// REST API Reference for GetBucketNotification Operation
public virtual IAsyncResult BeginGetBucketNotification(GetBucketNotificationRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetBucketNotificationRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetBucketNotificationResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the GetBucketNotification operation.
///
///
/// The IAsyncResult returned by the call to BeginGetBucketNotification.
///
/// Returns a GetBucketNotificationResult from S3.
/// REST API Reference for GetBucketNotification Operation
public virtual GetBucketNotificationResponse EndGetBucketNotification(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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);
}
///
/// Initiates the asynchronous execution of the GetBucketOwnershipControls operation.
///
///
/// Container for the necessary parameters to execute the GetBucketOwnershipControls operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketOwnershipControls
/// operation.
/// REST API Reference for GetBucketOwnershipControls Operation
public virtual IAsyncResult BeginGetBucketOwnershipControls(GetBucketOwnershipControlsRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetBucketOwnershipControlsRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetBucketOwnershipControlsResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the GetBucketOwnershipControls operation.
///
///
/// The IAsyncResult returned by the call to BeginGetBucketOwnershipControls.
///
/// Returns a GetBucketOwnershipControlsResult from S3.
/// REST API Reference for GetBucketOwnershipControls Operation
public virtual GetBucketOwnershipControlsResponse EndGetBucketOwnershipControls(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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);
}
///
/// Initiates the asynchronous execution of the GetBucketPolicy operation.
///
///
/// Container for the necessary parameters to execute the GetBucketPolicy operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketPolicy
/// operation.
/// REST API Reference for GetBucketPolicy Operation
public virtual IAsyncResult BeginGetBucketPolicy(GetBucketPolicyRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetBucketPolicyRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetBucketPolicyResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the GetBucketPolicy operation.
///
///
/// The IAsyncResult returned by the call to BeginGetBucketPolicy.
///
/// Returns a GetBucketPolicyResult from S3.
/// REST API Reference for GetBucketPolicy Operation
public virtual GetBucketPolicyResponse EndGetBucketPolicy(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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);
}
///
/// Initiates the asynchronous execution of the GetBucketPolicyStatus operation.
///
///
/// Container for the necessary parameters to execute the GetBucketPolicyStatus operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketPolicyStatus
/// operation.
/// REST API Reference for GetBucketPolicyStatus Operation
public virtual IAsyncResult BeginGetBucketPolicyStatus(GetBucketPolicyStatusRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetBucketPolicyStatusRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetBucketPolicyStatusResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the GetBucketPolicyStatus operation.
///
///
/// The IAsyncResult returned by the call to BeginGetBucketPolicyStatus.
///
/// Returns a GetBucketPolicyStatusResult from S3.
/// REST API Reference for GetBucketPolicyStatus Operation
public virtual GetBucketPolicyStatusResponse EndGetBucketPolicyStatus(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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);
}
///
/// Initiates the asynchronous execution of the GetBucketReplication operation.
///
///
/// Container for the necessary parameters to execute the GetBucketReplication operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketReplication
/// operation.
/// REST API Reference for GetBucketReplication Operation
public virtual IAsyncResult BeginGetBucketReplication(GetBucketReplicationRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetBucketReplicationRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetBucketReplicationResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the GetBucketReplication operation.
///
///
/// The IAsyncResult returned by the call to BeginGetBucketReplication.
///
/// Returns a GetBucketReplicationResult from S3.
/// REST API Reference for GetBucketReplication Operation
public virtual GetBucketReplicationResponse EndGetBucketReplication(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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);
}
///
/// Initiates the asynchronous execution of the GetBucketRequestPayment operation.
///
///
/// Container for the necessary parameters to execute the GetBucketRequestPayment operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketRequestPayment
/// operation.
/// REST API Reference for GetBucketRequestPayment Operation
public virtual IAsyncResult BeginGetBucketRequestPayment(GetBucketRequestPaymentRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetBucketRequestPaymentRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetBucketRequestPaymentResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the GetBucketRequestPayment operation.
///
///
/// The IAsyncResult returned by the call to BeginGetBucketRequestPayment.
///
/// Returns a GetBucketRequestPaymentResult from S3.
/// REST API Reference for GetBucketRequestPayment Operation
public virtual GetBucketRequestPaymentResponse EndGetBucketRequestPayment(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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);
}
///
/// Initiates the asynchronous execution of the GetBucketTagging operation.
///
///
/// Container for the necessary parameters to execute the GetBucketTagging operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketTagging
/// operation.
/// REST API Reference for GetBucketTagging Operation
public virtual IAsyncResult BeginGetBucketTagging(GetBucketTaggingRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetBucketTaggingRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetBucketTaggingResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the GetBucketTagging operation.
///
///
/// The IAsyncResult returned by the call to BeginGetBucketTagging.
///
/// Returns a GetBucketTaggingResult from S3.
/// REST API Reference for GetBucketTagging Operation
public virtual GetBucketTaggingResponse EndGetBucketTagging(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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);
}
///
/// Initiates the asynchronous execution of the GetBucketVersioning operation.
///
///
/// Container for the necessary parameters to execute the GetBucketVersioning operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketVersioning
/// operation.
/// REST API Reference for GetBucketVersioning Operation
public virtual IAsyncResult BeginGetBucketVersioning(GetBucketVersioningRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetBucketVersioningRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetBucketVersioningResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the GetBucketVersioning operation.
///
///
/// The IAsyncResult returned by the call to BeginGetBucketVersioning.
///
/// Returns a GetBucketVersioningResult from S3.
/// REST API Reference for GetBucketVersioning Operation
public virtual GetBucketVersioningResponse EndGetBucketVersioning(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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);
}
///
/// Initiates the asynchronous execution of the GetBucketWebsite operation.
///
///
/// Container for the necessary parameters to execute the GetBucketWebsite operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBucketWebsite
/// operation.
/// REST API Reference for GetBucketWebsite Operation
public virtual IAsyncResult BeginGetBucketWebsite(GetBucketWebsiteRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetBucketWebsiteRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetBucketWebsiteResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the GetBucketWebsite operation.
///
///
/// The IAsyncResult returned by the call to BeginGetBucketWebsite.
///
/// Returns a GetBucketWebsiteResult from S3.
/// REST API Reference for GetBucketWebsite Operation
public virtual GetBucketWebsiteResponse EndGetBucketWebsite(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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);
}
///
/// Initiates the asynchronous execution of the GetCORSConfiguration operation.
///
///
/// Container for the necessary parameters to execute the GetCORSConfiguration operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetCORSConfiguration
/// operation.
/// REST API Reference for GetCORSConfiguration Operation
public virtual IAsyncResult BeginGetCORSConfiguration(GetCORSConfigurationRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetCORSConfigurationRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetCORSConfigurationResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the GetCORSConfiguration operation.
///
///
/// The IAsyncResult returned by the call to BeginGetCORSConfiguration.
///
/// Returns a GetCORSConfigurationResult from S3.
/// REST API Reference for GetCORSConfiguration Operation
public virtual GetCORSConfigurationResponse EndGetCORSConfiguration(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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);
}
///
/// Initiates the asynchronous execution of the GetLifecycleConfiguration operation.
///
///
/// Container for the necessary parameters to execute the GetLifecycleConfiguration operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetLifecycleConfiguration
/// operation.
/// REST API Reference for GetLifecycleConfiguration Operation
public virtual IAsyncResult BeginGetLifecycleConfiguration(GetLifecycleConfigurationRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetLifecycleConfigurationRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetLifecycleConfigurationResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the GetLifecycleConfiguration operation.
///
///
/// The IAsyncResult returned by the call to BeginGetLifecycleConfiguration.
///
/// Returns a GetLifecycleConfigurationResult from S3.
/// REST API Reference for GetLifecycleConfiguration Operation
public virtual GetLifecycleConfigurationResponse EndGetLifecycleConfiguration(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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);
}
///
/// Initiates the asynchronous execution of the GetObject operation.
///
///
/// Container for the necessary parameters to execute the GetObject operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetObject
/// operation.
/// REST API Reference for GetObject Operation
public virtual IAsyncResult BeginGetObject(GetObjectRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetObjectRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetObjectResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the GetObject operation.
///
///
/// The IAsyncResult returned by the call to BeginGetObject.
///
/// Returns a GetObjectResult from S3.
/// REST API Reference for GetObject Operation
public virtual GetObjectResponse EndGetObject(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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);
}
///
/// Initiates the asynchronous execution of the GetObjectAttributes operation.
///
///
/// Container for the necessary parameters to execute the GetObjectAttributes operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetObjectAttributes
/// operation.
/// REST API Reference for GetObjectAttributes Operation
public virtual IAsyncResult BeginGetObjectAttributes(GetObjectAttributesRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetObjectAttributesRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetObjectAttributesResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the GetObjectAttributes operation.
///
///
/// The IAsyncResult returned by the call to BeginGetObjectAttributes.
///
/// Returns a GetObjectAttributesResult from S3.
/// REST API Reference for GetObjectAttributes Operation
public virtual GetObjectAttributesResponse EndGetObjectAttributes(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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);
}
///
/// Initiates the asynchronous execution of the GetObjectLegalHold operation.
///
///
/// Container for the necessary parameters to execute the GetObjectLegalHold operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetObjectLegalHold
/// operation.
/// REST API Reference for GetObjectLegalHold Operation
public virtual IAsyncResult BeginGetObjectLegalHold(GetObjectLegalHoldRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetObjectLegalHoldRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetObjectLegalHoldResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the GetObjectLegalHold operation.
///
///
/// The IAsyncResult returned by the call to BeginGetObjectLegalHold.
///
/// Returns a GetObjectLegalHoldResult from S3.
/// REST API Reference for GetObjectLegalHold Operation
public virtual GetObjectLegalHoldResponse EndGetObjectLegalHold(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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);
}
///
/// Initiates the asynchronous execution of the GetObjectLockConfiguration operation.
///
///
/// Container for the necessary parameters to execute the GetObjectLockConfiguration operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetObjectLockConfiguration
/// operation.
/// REST API Reference for GetObjectLockConfiguration Operation
public virtual IAsyncResult BeginGetObjectLockConfiguration(GetObjectLockConfigurationRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetObjectLockConfigurationRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetObjectLockConfigurationResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the GetObjectLockConfiguration operation.
///
///
/// The IAsyncResult returned by the call to BeginGetObjectLockConfiguration.
///
/// Returns a GetObjectLockConfigurationResult from S3.
/// REST API Reference for GetObjectLockConfiguration Operation
public virtual GetObjectLockConfigurationResponse EndGetObjectLockConfiguration(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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);
}
///
/// Initiates the asynchronous execution of the GetObjectMetadata operation.
///
///
/// Container for the necessary parameters to execute the GetObjectMetadata operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetObjectMetadata
/// operation.
/// REST API Reference for GetObjectMetadata Operation
public virtual IAsyncResult BeginGetObjectMetadata(GetObjectMetadataRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetObjectMetadataRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetObjectMetadataResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the GetObjectMetadata operation.
///
///
/// The IAsyncResult returned by the call to BeginGetObjectMetadata.
///
/// Returns a GetObjectMetadataResult from S3.
/// REST API Reference for GetObjectMetadata Operation
public virtual GetObjectMetadataResponse EndGetObjectMetadata(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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);
}
///
/// Initiates the asynchronous execution of the GetObjectRetention operation.
///
///
/// Container for the necessary parameters to execute the GetObjectRetention operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetObjectRetention
/// operation.
/// REST API Reference for GetObjectRetention Operation
public virtual IAsyncResult BeginGetObjectRetention(GetObjectRetentionRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetObjectRetentionRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetObjectRetentionResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the GetObjectRetention operation.
///
///
/// The IAsyncResult returned by the call to BeginGetObjectRetention.
///
/// Returns a GetObjectRetentionResult from S3.
/// REST API Reference for GetObjectRetention Operation
public virtual GetObjectRetentionResponse EndGetObjectRetention(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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);
}
///
/// Initiates the asynchronous execution of the GetObjectTagging operation.
///
///
/// Container for the necessary parameters to execute the GetObjectTagging operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetObjectTagging
/// operation.
/// REST API Reference for GetObjectTagging Operation
public virtual IAsyncResult BeginGetObjectTagging(GetObjectTaggingRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetObjectTaggingRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetObjectTaggingResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the GetObjectTagging operation.
///
///
/// The IAsyncResult returned by the call to BeginGetObjectTagging.
///
/// Returns a GetObjectTaggingResult from S3.
/// REST API Reference for GetObjectTagging Operation
public virtual GetObjectTaggingResponse EndGetObjectTagging(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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);
}
///
/// Initiates the asynchronous execution of the GetObjectTorrent operation.
///
///
/// Container for the necessary parameters to execute the GetObjectTorrent operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetObjectTorrent
/// operation.
/// REST API Reference for GetObjectTorrent Operation
public virtual IAsyncResult BeginGetObjectTorrent(GetObjectTorrentRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetObjectTorrentRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetObjectTorrentResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the GetObjectTorrent operation.
///
///
/// The IAsyncResult returned by the call to BeginGetObjectTorrent.
///
/// Returns a GetObjectTorrentResult from S3.
/// REST API Reference for GetObjectTorrent Operation
public virtual GetObjectTorrentResponse EndGetObjectTorrent(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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);
}
///
/// Initiates the asynchronous execution of the GetPublicAccessBlock operation.
///
///
/// Container for the necessary parameters to execute the GetPublicAccessBlock operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetPublicAccessBlock
/// operation.
/// REST API Reference for GetPublicAccessBlock Operation
public virtual IAsyncResult BeginGetPublicAccessBlock(GetPublicAccessBlockRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetPublicAccessBlockRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetPublicAccessBlockResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the GetPublicAccessBlock operation.
///
///
/// The IAsyncResult returned by the call to BeginGetPublicAccessBlock.
///
/// Returns a GetPublicAccessBlockResult from S3.
/// REST API Reference for GetPublicAccessBlock Operation
public virtual GetPublicAccessBlockResponse EndGetPublicAccessBlock(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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);
}
///
/// Initiates the asynchronous execution of the HeadBucket operation.
///
///
/// Container for the necessary parameters to execute the HeadBucket operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndHeadBucket
/// operation.
/// REST API Reference for HeadBucket Operation
internal virtual IAsyncResult BeginHeadBucket(HeadBucketRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = HeadBucketRequestMarshaller.Instance;
options.ResponseUnmarshaller = HeadBucketResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the HeadBucket operation.
///
///
/// The IAsyncResult returned by the call to BeginHeadBucket.
///
/// Returns a HeadBucketResult from S3.
/// REST API Reference for HeadBucket Operation
internal virtual HeadBucketResponse EndHeadBucket(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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);
}
///
/// Initiates the asynchronous execution of the InitiateMultipartUpload operation.
///
///
/// Container for the necessary parameters to execute the InitiateMultipartUpload operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndInitiateMultipartUpload
/// operation.
/// REST API Reference for InitiateMultipartUpload Operation
public virtual IAsyncResult BeginInitiateMultipartUpload(InitiateMultipartUploadRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = InitiateMultipartUploadRequestMarshaller.Instance;
options.ResponseUnmarshaller = InitiateMultipartUploadResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the InitiateMultipartUpload operation.
///
///
/// The IAsyncResult returned by the call to BeginInitiateMultipartUpload.
///
/// Returns a InitiateMultipartUploadResult from S3.
/// REST API Reference for InitiateMultipartUpload Operation
public virtual InitiateMultipartUploadResponse EndInitiateMultipartUpload(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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);
}
///
/// Initiates the asynchronous execution of the ListBucketAnalyticsConfigurations operation.
///
///
/// Container for the necessary parameters to execute the ListBucketAnalyticsConfigurations operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListBucketAnalyticsConfigurations
/// operation.
/// REST API Reference for ListBucketAnalyticsConfigurations Operation
public virtual IAsyncResult BeginListBucketAnalyticsConfigurations(ListBucketAnalyticsConfigurationsRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListBucketAnalyticsConfigurationsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListBucketAnalyticsConfigurationsResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the ListBucketAnalyticsConfigurations operation.
///
///
/// The IAsyncResult returned by the call to BeginListBucketAnalyticsConfigurations.
///
/// Returns a ListBucketAnalyticsConfigurationsResult from S3.
/// REST API Reference for ListBucketAnalyticsConfigurations Operation
public virtual ListBucketAnalyticsConfigurationsResponse EndListBucketAnalyticsConfigurations(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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);
}
///
/// Initiates the asynchronous execution of the ListBucketIntelligentTieringConfigurations operation.
///
///
/// Container for the necessary parameters to execute the ListBucketIntelligentTieringConfigurations operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListBucketIntelligentTieringConfigurations
/// operation.
/// REST API Reference for ListBucketIntelligentTieringConfigurations Operation
public virtual IAsyncResult BeginListBucketIntelligentTieringConfigurations(ListBucketIntelligentTieringConfigurationsRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListBucketIntelligentTieringConfigurationsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListBucketIntelligentTieringConfigurationsResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the ListBucketIntelligentTieringConfigurations operation.
///
///
/// The IAsyncResult returned by the call to BeginListBucketIntelligentTieringConfigurations.
///
/// Returns a ListBucketIntelligentTieringConfigurationsResult from S3.
/// REST API Reference for ListBucketIntelligentTieringConfigurations Operation
public virtual ListBucketIntelligentTieringConfigurationsResponse EndListBucketIntelligentTieringConfigurations(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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);
}
///
/// Initiates the asynchronous execution of the ListBucketInventoryConfigurations operation.
///
///
/// Container for the necessary parameters to execute the ListBucketInventoryConfigurations operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListBucketInventoryConfigurations
/// operation.
/// REST API Reference for ListBucketInventoryConfigurations Operation
public virtual IAsyncResult BeginListBucketInventoryConfigurations(ListBucketInventoryConfigurationsRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListBucketInventoryConfigurationsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListBucketInventoryConfigurationsResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the ListBucketInventoryConfigurations operation.
///
///
/// The IAsyncResult returned by the call to BeginListBucketInventoryConfigurations.
///
/// Returns a ListBucketInventoryConfigurationsResult from S3.
/// REST API Reference for ListBucketInventoryConfigurations Operation
public virtual ListBucketInventoryConfigurationsResponse EndListBucketInventoryConfigurations(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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);
}
///
/// Initiates the asynchronous execution of the ListBucketMetricsConfigurations operation.
///
///
/// Container for the necessary parameters to execute the ListBucketMetricsConfigurations operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListBucketMetricsConfigurations
/// operation.
/// REST API Reference for ListBucketMetricsConfigurations Operation
public virtual IAsyncResult BeginListBucketMetricsConfigurations(ListBucketMetricsConfigurationsRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListBucketMetricsConfigurationsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListBucketMetricsConfigurationsResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the ListBucketMetricsConfigurations operation.
///
///
/// The IAsyncResult returned by the call to BeginListBucketMetricsConfigurations.
///
/// Returns a ListBucketMetricsConfigurationsResult from S3.
/// REST API Reference for ListBucketMetricsConfigurations Operation
public virtual ListBucketMetricsConfigurationsResponse EndListBucketMetricsConfigurations(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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);
}
///
/// Initiates the asynchronous execution of the ListBuckets operation.
///
///
/// Container for the necessary parameters to execute the ListBuckets operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListBuckets
/// operation.
/// REST API Reference for ListBuckets Operation
public virtual IAsyncResult BeginListBuckets(ListBucketsRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListBucketsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListBucketsResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the ListBuckets operation.
///
///
/// The IAsyncResult returned by the call to BeginListBuckets.
///
/// Returns a ListBucketsResult from S3.
/// REST API Reference for ListBuckets Operation
public virtual ListBucketsResponse EndListBuckets(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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);
}
///
/// Initiates the asynchronous execution of the ListMultipartUploads operation.
///
///
/// Container for the necessary parameters to execute the ListMultipartUploads operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListMultipartUploads
/// operation.
/// REST API Reference for ListMultipartUploads Operation
public virtual IAsyncResult BeginListMultipartUploads(ListMultipartUploadsRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListMultipartUploadsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListMultipartUploadsResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the ListMultipartUploads operation.
///
///
/// The IAsyncResult returned by the call to BeginListMultipartUploads.
///
/// Returns a ListMultipartUploadsResult from S3.
/// REST API Reference for ListMultipartUploads Operation
public virtual ListMultipartUploadsResponse EndListMultipartUploads(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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);
}
///
/// Initiates the asynchronous execution of the ListObjects operation.
///
///
/// Container for the necessary parameters to execute the ListObjects operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListObjects
/// operation.
/// REST API Reference for ListObjects Operation
public virtual IAsyncResult BeginListObjects(ListObjectsRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListObjectsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListObjectsResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the ListObjects operation.
///
///
/// The IAsyncResult returned by the call to BeginListObjects.
///
/// Returns a ListObjectsResult from S3.
/// REST API Reference for ListObjects Operation
public virtual ListObjectsResponse EndListObjects(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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);
}
///
/// Initiates the asynchronous execution of the ListObjectsV2 operation.
///
///
/// Container for the necessary parameters to execute the ListObjectsV2 operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListObjectsV2
/// operation.
/// REST API Reference for ListObjectsV2 Operation
public virtual IAsyncResult BeginListObjectsV2(ListObjectsV2Request request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListObjectsV2RequestMarshaller.Instance;
options.ResponseUnmarshaller = ListObjectsV2ResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the ListObjectsV2 operation.
///
///
/// The IAsyncResult returned by the call to BeginListObjectsV2.
///
/// Returns a ListObjectsV2Result from S3.
/// REST API Reference for ListObjectsV2 Operation
public virtual ListObjectsV2Response EndListObjectsV2(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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);
}
///
/// Initiates the asynchronous execution of the ListParts operation.
///
///
/// Container for the necessary parameters to execute the ListParts operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListParts
/// operation.
/// REST API Reference for ListParts Operation
public virtual IAsyncResult BeginListParts(ListPartsRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListPartsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListPartsResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the ListParts operation.
///
///
/// The IAsyncResult returned by the call to BeginListParts.
///
/// Returns a ListPartsResult from S3.
/// REST API Reference for ListParts Operation
public virtual ListPartsResponse EndListParts(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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);
}
///
/// Initiates the asynchronous execution of the ListVersions operation.
///
///
/// Container for the necessary parameters to execute the ListVersions operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListVersions
/// operation.
/// REST API Reference for ListVersions Operation
public virtual IAsyncResult BeginListVersions(ListVersionsRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListVersionsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListVersionsResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the ListVersions operation.
///
///
/// The IAsyncResult returned by the call to BeginListVersions.
///
/// Returns a ListVersionsResult from S3.
/// REST API Reference for ListVersions Operation
public virtual ListVersionsResponse EndListVersions(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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);
}
///
/// Initiates the asynchronous execution of the PutACL operation.
///
///
/// Container for the necessary parameters to execute the PutACL operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutACL
/// operation.
/// REST API Reference for PutACL Operation
public virtual IAsyncResult BeginPutACL(PutACLRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = PutACLRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutACLResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the PutACL operation.
///
///
/// The IAsyncResult returned by the call to BeginPutACL.
///
/// Returns a PutACLResult from S3.
/// REST API Reference for PutACL Operation
public virtual PutACLResponse EndPutACL(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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. 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. 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);
}
///
/// Initiates the asynchronous execution of the PutBucket operation.
///
///
/// Container for the necessary parameters to execute the PutBucket operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucket
/// operation.
/// REST API Reference for PutBucket Operation
public virtual IAsyncResult BeginPutBucket(PutBucketRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = PutBucketRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutBucketResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the PutBucket operation.
///
///
/// The IAsyncResult returned by the call to BeginPutBucket.
///
/// Returns a PutBucketResult from S3.
/// REST API Reference for PutBucket Operation
public virtual PutBucketResponse EndPutBucket(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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);
}
///
/// Initiates the asynchronous execution of the PutBucketAccelerateConfiguration operation.
///
///
/// Container for the necessary parameters to execute the PutBucketAccelerateConfiguration operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketAccelerateConfiguration
/// operation.
/// REST API Reference for PutBucketAccelerateConfiguration Operation
public virtual IAsyncResult BeginPutBucketAccelerateConfiguration(PutBucketAccelerateConfigurationRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = PutBucketAccelerateConfigurationRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutBucketAccelerateConfigurationResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the PutBucketAccelerateConfiguration operation.
///
///
/// The IAsyncResult returned by the call to BeginPutBucketAccelerateConfiguration.
///
/// Returns a PutBucketAccelerateConfigurationResult from S3.
/// REST API Reference for PutBucketAccelerateConfiguration Operation
public virtual PutBucketAccelerateConfigurationResponse EndPutBucketAccelerateConfiguration(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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);
}
///
/// Initiates the asynchronous execution of the PutBucketAnalyticsConfiguration operation.
///
///
/// Container for the necessary parameters to execute the PutBucketAnalyticsConfiguration operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketAnalyticsConfiguration
/// operation.
/// REST API Reference for PutBucketAnalyticsConfiguration Operation
public virtual IAsyncResult BeginPutBucketAnalyticsConfiguration(PutBucketAnalyticsConfigurationRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = PutBucketAnalyticsConfigurationRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutBucketAnalyticsConfigurationResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the PutBucketAnalyticsConfiguration operation.
///
///
/// The IAsyncResult returned by the call to BeginPutBucketAnalyticsConfiguration.
///
/// Returns a PutBucketAnalyticsConfigurationResult from S3.
/// REST API Reference for PutBucketAnalyticsConfiguration Operation
public virtual PutBucketAnalyticsConfigurationResponse EndPutBucketAnalyticsConfiguration(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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), dual-layer server-side encryption with Amazon Web Services KMS
/// keys (DSSE-KMS), or server-side encryption with customer-provided keys (SSE-C). If
/// you specify default encryption by using SSE-KMS, you can also configure Amazon S3
/// Bucket Keys. For information about bucket default encryption, see Amazon
/// S3 bucket default encryption in the Amazon S3 User Guide. For more information
/// about S3 Bucket Keys, see Amazon
/// S3 Bucket Keys in the Amazon S3 User Guide.
///
///
///
/// This action requires Amazon Web Services Signature Version 4. For more information,
/// see
/// Authenticating Requests (Amazon Web Services Signature Version 4).
///
///
///
/// To use this operation, you must have 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);
}
///
/// Initiates the asynchronous execution of the PutBucketEncryption operation.
///
///
/// Container for the necessary parameters to execute the PutBucketEncryption operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketEncryption
/// operation.
/// REST API Reference for PutBucketEncryption Operation
public virtual IAsyncResult BeginPutBucketEncryption(PutBucketEncryptionRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = PutBucketEncryptionRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutBucketEncryptionResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the PutBucketEncryption operation.
///
///
/// The IAsyncResult returned by the call to BeginPutBucketEncryption.
///
/// Returns a PutBucketEncryptionResult from S3.
/// REST API Reference for PutBucketEncryption Operation
public virtual PutBucketEncryptionResponse EndPutBucketEncryption(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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:
///
///
///
///
/// You only need S3 Intelligent-Tiering enabled on a bucket if you want to automatically
/// move objects stored in the S3 Intelligent-Tiering storage class to the Archive Access
/// or Deep Archive Access tier.
///
///
///
/// PutBucketIntelligentTieringConfiguration has the following special errors:
///
/// - HTTP 400 Bad Request Error
-
///
/// Code: InvalidArgument
///
///
///
/// Cause: Invalid Argument
///
///
- HTTP 400 Bad Request Error
-
///
/// Code: TooManyConfigurations
///
///
///
/// Cause: You are attempting to create a new configuration but have already reached
/// the 1,000-configuration limit.
///
///
- HTTP 403 Forbidden Error
-
///
/// Cause: You are not the owner of the specified bucket, or you do not have the
///
s3:PutIntelligentTieringConfiguration bucket permission to set the configuration
/// on the bucket.
///
///
///
/// Container for the necessary parameters to execute the PutBucketIntelligentTieringConfiguration service method.
///
/// The response from the PutBucketIntelligentTieringConfiguration service method, as returned by S3.
/// REST API Reference for PutBucketIntelligentTieringConfiguration Operation
public virtual PutBucketIntelligentTieringConfigurationResponse PutBucketIntelligentTieringConfiguration(PutBucketIntelligentTieringConfigurationRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = PutBucketIntelligentTieringConfigurationRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutBucketIntelligentTieringConfigurationResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the PutBucketIntelligentTieringConfiguration operation.
///
///
/// Container for the necessary parameters to execute the PutBucketIntelligentTieringConfiguration operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketIntelligentTieringConfiguration
/// operation.
/// REST API Reference for PutBucketIntelligentTieringConfiguration Operation
public virtual IAsyncResult BeginPutBucketIntelligentTieringConfiguration(PutBucketIntelligentTieringConfigurationRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = PutBucketIntelligentTieringConfigurationRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutBucketIntelligentTieringConfigurationResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the PutBucketIntelligentTieringConfiguration operation.
///
///
/// The IAsyncResult returned by the call to BeginPutBucketIntelligentTieringConfiguration.
///
/// Returns a PutBucketIntelligentTieringConfigurationResult from S3.
/// REST API Reference for PutBucketIntelligentTieringConfiguration Operation
public virtual PutBucketIntelligentTieringConfigurationResponse EndPutBucketIntelligentTieringConfiguration(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#endregion
#region PutBucketInventoryConfiguration
///
/// This implementation of the PUT action adds an inventory configuration
/// (identified by the inventory ID) to the bucket. You can have up to 1,000 inventory
/// configurations per bucket.
///
///
///
/// Amazon S3 inventory generates inventories of the objects in the bucket on a daily
/// or weekly basis, and the results are published to a flat file. The bucket that is
/// inventoried is called the source bucket, and the bucket where the inventory
/// flat file is stored is called the destination bucket. The destination
/// bucket must be in the same Amazon Web Services Region as the source bucket.
///
///
///
///
/// When you configure an inventory for a source bucket, you specify the destination
/// bucket where you want the inventory to be stored, and whether to generate the inventory
/// daily or weekly. You can also configure what object metadata to include and whether
/// to inventory all object versions or only current versions. For more information, see
/// Amazon
/// S3 Inventory in the Amazon S3 User Guide.
///
///
///
/// You must create a bucket policy on the destination bucket to grant permissions
/// to Amazon S3 to write objects to the bucket in the defined location. For an example
/// policy, see
/// Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.
///
/// - Permissions
-
///
/// To use this operation, you must have permission to perform the
s3:PutInventoryConfiguration
/// action. The bucket owner has this permission by default and can grant this permission
/// to others.
///
///
///
/// The s3:PutInventoryConfiguration permission allows a user to create an
/// S3
/// Inventory report that includes all object metadata fields available and to specify
/// the destination bucket to store the inventory. A user with read access to objects
/// in the destination bucket can also access all object metadata fields that are available
/// in the inventory report.
///
///
///
/// To restrict access to an inventory report, see Restricting
/// access to an Amazon S3 Inventory report in the Amazon S3 User Guide. For
/// more information about the metadata fields available in S3 Inventory, see Amazon
/// S3 Inventory lists in the Amazon S3 User Guide. For more information about
/// permissions, see Permissions
/// related to bucket subresource operations and Identity
/// and access management in Amazon S3 in the Amazon S3 User Guide.
///
///
///
/// PutBucketInventoryConfiguration has the following special errors:
///
/// - HTTP 400 Bad Request Error
-
///
/// Code: InvalidArgument
///
///
///
/// Cause: Invalid Argument
///
///
- HTTP 400 Bad Request Error
-
///
/// Code: TooManyConfigurations
///
///
///
/// Cause: You are attempting to create a new configuration but have already reached
/// the 1,000-configuration limit.
///
///
- HTTP 403 Forbidden Error
-
///
/// Cause: You are not the owner of the specified bucket, or you do not have the
///
s3:PutInventoryConfiguration bucket permission to set the configuration
/// on the bucket.
///
///
///
/// The following operations are related to PutBucketInventoryConfiguration:
///
///
///
/// Container for the necessary parameters to execute the PutBucketInventoryConfiguration service method.
///
/// The response from the PutBucketInventoryConfiguration service method, as returned by S3.
/// REST API Reference for PutBucketInventoryConfiguration Operation
public virtual PutBucketInventoryConfigurationResponse PutBucketInventoryConfiguration(PutBucketInventoryConfigurationRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = PutBucketInventoryConfigurationRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutBucketInventoryConfigurationResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the PutBucketInventoryConfiguration operation.
///
///
/// Container for the necessary parameters to execute the PutBucketInventoryConfiguration operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketInventoryConfiguration
/// operation.
/// REST API Reference for PutBucketInventoryConfiguration Operation
public virtual IAsyncResult BeginPutBucketInventoryConfiguration(PutBucketInventoryConfigurationRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = PutBucketInventoryConfigurationRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutBucketInventoryConfigurationResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the PutBucketInventoryConfiguration operation.
///
///
/// The IAsyncResult returned by the call to BeginPutBucketInventoryConfiguration.
///
/// Returns a PutBucketInventoryConfigurationResult from S3.
/// REST API Reference for PutBucketInventoryConfiguration Operation
public virtual PutBucketInventoryConfigurationResponse EndPutBucketInventoryConfiguration(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#endregion
#region PutBucketLogging
///
/// Set the logging parameters for a bucket and to specify permissions for who can view
/// and modify the logging parameters. All logs are saved to buckets in the same Amazon
/// Web Services Region as the source bucket. To set the logging status of a bucket, you
/// must be the bucket owner.
///
///
///
/// The bucket owner is automatically granted FULL_CONTROL to all logs. You use the Grantee
/// request element to grant access to other people. The Permissions request
/// element specifies the kind of access the grantee has to the logs.
///
///
///
/// If the target bucket for log delivery uses the bucket owner enforced setting for S3
/// Object Ownership, you can't use the Grantee request element to grant
/// access to others. Permissions can only be granted using policies. For more information,
/// see Permissions
/// for server access log delivery in the Amazon S3 User Guide.
///
/// - Grantee Values
-
///
/// You can specify the person (grantee) to whom you're assigning access rights (by 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 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
/// GETObjectAcl request, appears as the CanonicalUser.
///
/// -
///
/// 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>
///
///
///
///
/// To enable logging, you use LoggingEnabled and its children request elements.
/// To disable logging, you use an empty BucketLoggingStatus request element:
///
///
///
/// <BucketLoggingStatus xmlns="http://doc.s3.amazonaws.com/2006-03-01" />
///
///
///
///
/// For more information about server access logging, see Server
/// Access Logging in the Amazon S3 User Guide.
///
///
///
/// For more information about creating a bucket, see CreateBucket.
/// For more information about returning the logging status of a bucket, see GetBucketLogging.
///
///
///
/// The following operations are related to PutBucketLogging:
///
///
///
/// Container for the necessary parameters to execute the PutBucketLogging service method.
///
/// The response from the PutBucketLogging service method, as returned by S3.
/// REST API Reference for PutBucketLogging Operation
public virtual PutBucketLoggingResponse PutBucketLogging(PutBucketLoggingRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = PutBucketLoggingRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutBucketLoggingResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the PutBucketLogging operation.
///
///
/// Container for the necessary parameters to execute the PutBucketLogging operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketLogging
/// operation.
/// REST API Reference for PutBucketLogging Operation
public virtual IAsyncResult BeginPutBucketLogging(PutBucketLoggingRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = PutBucketLoggingRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutBucketLoggingResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the PutBucketLogging operation.
///
///
/// The IAsyncResult returned by the call to BeginPutBucketLogging.
///
/// Returns a PutBucketLoggingResult from S3.
/// REST API Reference for PutBucketLogging Operation
public virtual PutBucketLoggingResponse EndPutBucketLogging(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#endregion
#region PutBucketMetricsConfiguration
///
/// Sets a metrics configuration (specified by the metrics configuration ID) for the bucket.
/// You can have up to 1,000 metrics configurations per bucket. If you're updating an
/// existing metrics configuration, note that this is a full replacement of the existing
/// metrics configuration. If you don't include the elements you want to keep, they are
/// erased.
///
///
///
/// To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration
/// action. The bucket owner has this permission by default. The bucket owner can grant
/// this permission to others. For more information about permissions, see Permissions
/// Related to Bucket Subresource Operations and Managing
/// Access Permissions to Your Amazon S3 Resources.
///
///
///
/// For information about CloudWatch request metrics for Amazon S3, see Monitoring
/// Metrics with Amazon CloudWatch.
///
///
///
/// The following operations are related to PutBucketMetricsConfiguration:
///
///
///
/// PutBucketMetricsConfiguration has the following special error:
///
/// -
///
/// Error code:
TooManyConfigurations
///
/// -
///
/// Description: You are attempting to create a new configuration but have already reached
/// the 1,000-configuration limit.
///
///
-
///
/// HTTP Status Code: HTTP 400 Bad Request
///
///
///
/// Container for the necessary parameters to execute the PutBucketMetricsConfiguration service method.
///
/// The response from the PutBucketMetricsConfiguration service method, as returned by S3.
/// REST API Reference for PutBucketMetricsConfiguration Operation
public virtual PutBucketMetricsConfigurationResponse PutBucketMetricsConfiguration(PutBucketMetricsConfigurationRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = PutBucketMetricsConfigurationRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutBucketMetricsConfigurationResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the PutBucketMetricsConfiguration operation.
///
///
/// Container for the necessary parameters to execute the PutBucketMetricsConfiguration operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketMetricsConfiguration
/// operation.
/// REST API Reference for PutBucketMetricsConfiguration Operation
public virtual IAsyncResult BeginPutBucketMetricsConfiguration(PutBucketMetricsConfigurationRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = PutBucketMetricsConfigurationRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutBucketMetricsConfigurationResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the PutBucketMetricsConfiguration operation.
///
///
/// The IAsyncResult returned by the call to BeginPutBucketMetricsConfiguration.
///
/// Returns a PutBucketMetricsConfigurationResult from S3.
/// REST API Reference for PutBucketMetricsConfiguration Operation
public virtual PutBucketMetricsConfigurationResponse EndPutBucketMetricsConfiguration(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#endregion
#region PutBucketNotification
///
/// Enables notifications of specified events for a bucket. For more information about
/// event notifications, see Configuring
/// Event Notifications.
///
///
///
/// Using this API, you can replace an existing notification configuration. The configuration
/// is an XML file that defines the event types that you want Amazon S3 to publish and
/// the destination where you want Amazon S3 to publish an event notification when it
/// detects an event of the specified type.
///
///
///
/// By default, your bucket has no event notifications configured. That is, the notification
/// configuration will be an empty NotificationConfiguration.
///
///
///
/// <NotificationConfiguration>
///
///
///
/// </NotificationConfiguration>
///
///
///
/// This action replaces the existing notification configuration with the configuration
/// you include in the request body.
///
///
///
/// After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification
/// Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists,
/// and that the bucket owner has permission to publish to it by sending a test notification.
/// In the case of Lambda destinations, Amazon S3 verifies that the Lambda function permissions
/// grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. For more
/// information, see Configuring
/// Notifications for Amazon S3 Events.
///
///
///
/// You can disable notifications by adding the empty NotificationConfiguration element.
///
///
///
/// For more information about the number of event notification configurations that you
/// can create per bucket, see Amazon
/// S3 service quotas in Amazon Web Services General Reference.
///
///
///
/// By default, only the bucket owner can configure notifications on a bucket. However,
/// bucket owners can use a bucket policy to grant permission to other users to set this
/// configuration with the required s3:PutBucketNotification permission.
///
///
///
/// The PUT notification is an atomic operation. For example, suppose your notification
/// configuration includes SNS topic, SQS queue, and Lambda function configurations. When
/// you send a PUT request with this configuration, Amazon S3 sends test messages to your
/// SNS topic. If the message fails, the entire PUT action will fail, and Amazon S3 will
/// not add the configuration to your bucket.
///
///
///
/// If the configuration in the request body includes only one TopicConfiguration
/// specifying only the s3:ReducedRedundancyLostObject event type, the response
/// will also include the x-amz-sns-test-message-id header containing the
/// message ID of the test notification sent to the topic.
///
///
///
/// The following action is related to PutBucketNotificationConfiguration:
///
///
///
/// Container for the necessary parameters to execute the PutBucketNotification service method.
///
/// The response from the PutBucketNotification service method, as returned by S3.
/// REST API Reference for PutBucketNotification Operation
public virtual PutBucketNotificationResponse PutBucketNotification(PutBucketNotificationRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = PutBucketNotificationRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutBucketNotificationResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the PutBucketNotification operation.
///
///
/// Container for the necessary parameters to execute the PutBucketNotification operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketNotification
/// operation.
/// REST API Reference for PutBucketNotification Operation
public virtual IAsyncResult BeginPutBucketNotification(PutBucketNotificationRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = PutBucketNotificationRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutBucketNotificationResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the PutBucketNotification operation.
///
///
/// The IAsyncResult returned by the call to BeginPutBucketNotification.
///
/// Returns a PutBucketNotificationResult from S3.
/// REST API Reference for PutBucketNotification Operation
public virtual PutBucketNotificationResponse EndPutBucketNotification(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#endregion
#region PutBucketOwnershipControls
///
/// Creates or modifies OwnershipControls for an Amazon S3 bucket. To use
/// this operation, you must have the s3:PutBucketOwnershipControls permission.
/// For more information about Amazon S3 permissions, see Specifying
/// permissions in a policy.
///
///
///
/// For information about Amazon S3 Object Ownership, see Using
/// object ownership.
///
///
///
/// The following operations are related to PutBucketOwnershipControls:
///
///
///
/// Container for the necessary parameters to execute the PutBucketOwnershipControls service method.
///
/// The response from the PutBucketOwnershipControls service method, as returned by S3.
/// REST API Reference for PutBucketOwnershipControls Operation
public virtual PutBucketOwnershipControlsResponse PutBucketOwnershipControls(PutBucketOwnershipControlsRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = PutBucketOwnershipControlsRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutBucketOwnershipControlsResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the PutBucketOwnershipControls operation.
///
///
/// Container for the necessary parameters to execute the PutBucketOwnershipControls operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketOwnershipControls
/// operation.
/// REST API Reference for PutBucketOwnershipControls Operation
public virtual IAsyncResult BeginPutBucketOwnershipControls(PutBucketOwnershipControlsRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = PutBucketOwnershipControlsRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutBucketOwnershipControlsResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the PutBucketOwnershipControls operation.
///
///
/// The IAsyncResult returned by the call to BeginPutBucketOwnershipControls.
///
/// Returns a PutBucketOwnershipControlsResult from S3.
/// REST API Reference for PutBucketOwnershipControls Operation
public virtual PutBucketOwnershipControlsResponse EndPutBucketOwnershipControls(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#endregion
#region PutBucketPolicy
///
/// Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity
/// other than the root user of the Amazon Web Services account that owns the bucket,
/// the calling identity must have the PutBucketPolicy permissions on the
/// specified bucket and belong to the bucket owner's account in order to use this operation.
///
///
///
/// If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403
/// Access Denied error. If you have the correct permissions, but you're not using
/// an identity that belongs to the bucket owner's account, Amazon S3 returns a 405
/// Method Not Allowed error.
///
///
///
/// 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, see Bucket
/// policy examples.
///
///
///
/// The following operations are related to PutBucketPolicy:
///
///
///
/// The name of the bucket.
/// The bucket policy as a JSON document.
///
/// The response from the PutBucketPolicy service method, as returned by S3.
/// REST API Reference for PutBucketPolicy Operation
public virtual PutBucketPolicyResponse PutBucketPolicy(string bucketName, string policy)
{
var request = new PutBucketPolicyRequest();
request.BucketName = bucketName;
request.Policy = policy;
return PutBucketPolicy(request);
}
///
/// Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity
/// other than the root user of the Amazon Web Services account that owns the bucket,
/// the calling identity must have the PutBucketPolicy permissions on the
/// specified bucket and belong to the bucket owner's account in order to use this operation.
///
///
///
/// If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403
/// Access Denied error. If you have the correct permissions, but you're not using
/// an identity that belongs to the bucket owner's account, Amazon S3 returns a 405
/// Method Not Allowed error.
///
///
///
/// 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, see Bucket
/// policy examples.
///
///
///
/// The following operations are related to PutBucketPolicy:
///
///
///
/// The name of the bucket.
/// The bucket policy as a JSON document.
/// The MD5 hash of the request body. For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.
///
/// The response from the PutBucketPolicy service method, as returned by S3.
/// REST API Reference for PutBucketPolicy Operation
public virtual PutBucketPolicyResponse PutBucketPolicy(string bucketName, string policy, string contentMD5)
{
var request = new PutBucketPolicyRequest();
request.BucketName = bucketName;
request.Policy = policy;
request.ContentMD5 = contentMD5;
return PutBucketPolicy(request);
}
///
/// Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity
/// other than the root user of the Amazon Web Services account that owns the bucket,
/// the calling identity must have the PutBucketPolicy permissions on the
/// specified bucket and belong to the bucket owner's account in order to use this operation.
///
///
///
/// If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403
/// Access Denied error. If you have the correct permissions, but you're not using
/// an identity that belongs to the bucket owner's account, Amazon S3 returns a 405
/// Method Not Allowed error.
///
///
///
/// 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, see Bucket
/// policy examples.
///
///
///
/// The following operations are related to PutBucketPolicy:
///
///
///
/// Container for the necessary parameters to execute the PutBucketPolicy service method.
///
/// The response from the PutBucketPolicy service method, as returned by S3.
/// REST API Reference for PutBucketPolicy Operation
public virtual PutBucketPolicyResponse PutBucketPolicy(PutBucketPolicyRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = PutBucketPolicyRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutBucketPolicyResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the PutBucketPolicy operation.
///
///
/// Container for the necessary parameters to execute the PutBucketPolicy operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketPolicy
/// operation.
/// REST API Reference for PutBucketPolicy Operation
public virtual IAsyncResult BeginPutBucketPolicy(PutBucketPolicyRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = PutBucketPolicyRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutBucketPolicyResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the PutBucketPolicy operation.
///
///
/// The IAsyncResult returned by the call to BeginPutBucketPolicy.
///
/// Returns a PutBucketPolicyResult from S3.
/// REST API Reference for PutBucketPolicy Operation
public virtual PutBucketPolicyResponse EndPutBucketPolicy(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#endregion
#region PutBucketReplication
///
/// Creates a replication configuration or replaces an existing one. For more information,
/// see Replication
/// in the Amazon S3 User Guide.
///
///
///
/// Specify the replication configuration in the request body. In the replication configuration,
/// you provide the name of the destination bucket or buckets where you want Amazon S3
/// to replicate objects, the IAM role that Amazon S3 can assume to replicate objects
/// on your behalf, and other relevant information.
///
///
///
/// A replication configuration must include at least one rule, and can contain a maximum
/// of 1,000. Each rule identifies a subset of objects to replicate by filtering the objects
/// in the source bucket. To choose additional subsets of objects to replicate, add a
/// rule for each subset.
///
///
///
/// To specify a subset of the objects in the source bucket to apply a replication rule
/// to, add the Filter element as a child of the Rule element. You can filter objects
/// based on an object key prefix, one or more object tags, or both. When you add the
/// Filter element in the configuration, you must also add the following elements: DeleteMarkerReplication,
/// Status, and Priority.
///
///
///
/// If you are using an earlier version of the replication configuration, Amazon S3 handles
/// replication of delete markers differently. For more information, see Backward
/// Compatibility.
///
///
///
/// For information about enabling versioning on a bucket, see Using
/// Versioning.
///
/// - Handling Replication of Encrypted Objects
-
///
/// By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side
/// encryption with KMS keys. To replicate Amazon Web Services KMS-encrypted objects,
/// add the following:
SourceSelectionCriteria, SseKmsEncryptedObjects,
/// Status, EncryptionConfiguration, and ReplicaKmsKeyID.
/// For information about replication configuration, see Replicating
/// Objects Created with SSE Using KMS keys.
///
///
///
/// For information on PutBucketReplication errors, see List
/// of replication-related error codes
///
/// - Permissions
-
///
/// To create a
PutBucketReplication request, you must have s3:PutReplicationConfiguration
/// permissions for the bucket.
///
///
///
/// By default, a resource owner, in this case the Amazon Web Services account that created
/// the bucket, can perform this operation. The resource owner can also grant others permissions
/// to perform the operation. For more information about permissions, see Specifying
/// Permissions in a Policy and Managing
/// Access Permissions to Your Amazon S3 Resources.
///
///
///
/// To perform this operation, the user or role performing the action must have the iam:PassRole
/// permission.
///
///
///
/// The following operations are related to PutBucketReplication:
///
///
///
/// Container for the necessary parameters to execute the PutBucketReplication service method.
///
/// The response from the PutBucketReplication service method, as returned by S3.
/// REST API Reference for PutBucketReplication Operation
public virtual PutBucketReplicationResponse PutBucketReplication(PutBucketReplicationRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = PutBucketReplicationRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutBucketReplicationResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the PutBucketReplication operation.
///
///
/// Container for the necessary parameters to execute the PutBucketReplication operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketReplication
/// operation.
/// REST API Reference for PutBucketReplication Operation
public virtual IAsyncResult BeginPutBucketReplication(PutBucketReplicationRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = PutBucketReplicationRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutBucketReplicationResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the PutBucketReplication operation.
///
///
/// The IAsyncResult returned by the call to BeginPutBucketReplication.
///
/// Returns a PutBucketReplicationResult from S3.
/// REST API Reference for PutBucketReplication Operation
public virtual PutBucketReplicationResponse EndPutBucketReplication(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#endregion
#region PutBucketRequestPayment
///
/// Sets the request payment configuration for a bucket. By default, the bucket owner
/// pays for downloads from the bucket. This configuration parameter enables the bucket
/// owner (only) to specify that the person requesting the download will be charged for
/// the download. For more information, see Requester
/// Pays Buckets.
///
///
///
/// The following operations are related to PutBucketRequestPayment:
///
///
///
/// The bucket name.
/// Container for Payer.
///
/// The response from the PutBucketRequestPayment service method, as returned by S3.
/// REST API Reference for PutBucketRequestPayment Operation
public virtual PutBucketRequestPaymentResponse PutBucketRequestPayment(string bucketName, RequestPaymentConfiguration requestPaymentConfiguration)
{
var request = new PutBucketRequestPaymentRequest();
request.BucketName = bucketName;
request.RequestPaymentConfiguration = requestPaymentConfiguration;
return PutBucketRequestPayment(request);
}
///
/// Sets the request payment configuration for a bucket. By default, the bucket owner
/// pays for downloads from the bucket. This configuration parameter enables the bucket
/// owner (only) to specify that the person requesting the download will be charged for
/// the download. For more information, see Requester
/// Pays Buckets.
///
///
///
/// The following operations are related to PutBucketRequestPayment:
///
///
///
/// Container for the necessary parameters to execute the PutBucketRequestPayment service method.
///
/// The response from the PutBucketRequestPayment service method, as returned by S3.
/// REST API Reference for PutBucketRequestPayment Operation
public virtual PutBucketRequestPaymentResponse PutBucketRequestPayment(PutBucketRequestPaymentRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = PutBucketRequestPaymentRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutBucketRequestPaymentResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the PutBucketRequestPayment operation.
///
///
/// Container for the necessary parameters to execute the PutBucketRequestPayment operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketRequestPayment
/// operation.
/// REST API Reference for PutBucketRequestPayment Operation
public virtual IAsyncResult BeginPutBucketRequestPayment(PutBucketRequestPaymentRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = PutBucketRequestPaymentRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutBucketRequestPaymentResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the PutBucketRequestPayment operation.
///
///
/// The IAsyncResult returned by the call to BeginPutBucketRequestPayment.
///
/// Returns a PutBucketRequestPaymentResult from S3.
/// REST API Reference for PutBucketRequestPayment Operation
public virtual PutBucketRequestPaymentResponse EndPutBucketRequestPayment(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#endregion
#region PutBucketTagging
///
/// Sets the tags for a bucket.
///
///
///
/// Use tags to organize your Amazon Web Services bill to reflect your own cost structure.
/// To do this, sign up to get your Amazon Web Services account bill with tag key values
/// included. Then, to see the cost of combined resources, organize your billing information
/// according to resources with the same tag key values. For example, you can tag several
/// resources with a specific application name, and then organize your billing information
/// to see the total cost of that application across several services. For more information,
/// see Cost
/// Allocation and Tagging and Using
/// Cost Allocation in Amazon S3 Bucket Tags.
///
///
///
/// When this operation sets the tags for a bucket, it will overwrite any current tags
/// the bucket already has. You cannot use this operation to add tags to an existing list
/// of tags.
///
///
///
/// To use this operation, you must have permissions to perform the s3:PutBucketTagging
/// action. The bucket owner has this permission by default and can grant this permission
/// to others. For more information about permissions, see Permissions
/// Related to Bucket Subresource Operations and Managing
/// Access Permissions to Your Amazon S3 Resources.
///
///
///
/// PutBucketTagging has the following special errors:
///
/// -
///
/// Error code:
InvalidTagError
///
/// -
///
/// Error code:
MalformedXMLError
///
/// -
///
/// Description: The XML provided does not match the schema.
///
///
-
///
/// Error code:
OperationAbortedError
///
/// -
///
/// Description: A conflicting conditional action is currently in progress against this
/// resource. Please try again.
///
///
-
///
/// Error code:
InternalError
///
/// -
///
/// Description: The service was unable to apply the provided tag to the bucket.
///
///
///
/// The following operations are related to PutBucketTagging:
///
///
///
/// The bucket name.
/// A property of PutBucketTaggingRequest used to execute the PutBucketTagging service method.
///
/// The response from the PutBucketTagging service method, as returned by S3.
/// REST API Reference for PutBucketTagging Operation
public virtual PutBucketTaggingResponse PutBucketTagging(string bucketName, List tagSet)
{
var request = new PutBucketTaggingRequest();
request.BucketName = bucketName;
request.TagSet = tagSet;
return PutBucketTagging(request);
}
///
/// Sets the tags for a bucket.
///
///
///
/// Use tags to organize your Amazon Web Services bill to reflect your own cost structure.
/// To do this, sign up to get your Amazon Web Services account bill with tag key values
/// included. Then, to see the cost of combined resources, organize your billing information
/// according to resources with the same tag key values. For example, you can tag several
/// resources with a specific application name, and then organize your billing information
/// to see the total cost of that application across several services. For more information,
/// see Cost
/// Allocation and Tagging and Using
/// Cost Allocation in Amazon S3 Bucket Tags.
///
///
///
/// When this operation sets the tags for a bucket, it will overwrite any current tags
/// the bucket already has. You cannot use this operation to add tags to an existing list
/// of tags.
///
///
///
/// To use this operation, you must have permissions to perform the s3:PutBucketTagging
/// action. The bucket owner has this permission by default and can grant this permission
/// to others. For more information about permissions, see Permissions
/// Related to Bucket Subresource Operations and Managing
/// Access Permissions to Your Amazon S3 Resources.
///
///
///
/// PutBucketTagging has the following special errors:
///
/// -
///
/// Error code:
InvalidTagError
///
/// -
///
/// Error code:
MalformedXMLError
///
/// -
///
/// Description: The XML provided does not match the schema.
///
///
-
///
/// Error code:
OperationAbortedError
///
/// -
///
/// Description: A conflicting conditional action is currently in progress against this
/// resource. Please try again.
///
///
-
///
/// Error code:
InternalError
///
/// -
///
/// Description: The service was unable to apply the provided tag to the bucket.
///
///
///
/// The following operations are related to PutBucketTagging:
///
///
///
/// Container for the necessary parameters to execute the PutBucketTagging service method.
///
/// The response from the PutBucketTagging service method, as returned by S3.
/// REST API Reference for PutBucketTagging Operation
public virtual PutBucketTaggingResponse PutBucketTagging(PutBucketTaggingRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = PutBucketTaggingRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutBucketTaggingResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the PutBucketTagging operation.
///
///
/// Container for the necessary parameters to execute the PutBucketTagging operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketTagging
/// operation.
/// REST API Reference for PutBucketTagging Operation
public virtual IAsyncResult BeginPutBucketTagging(PutBucketTaggingRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = PutBucketTaggingRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutBucketTaggingResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the PutBucketTagging operation.
///
///
/// The IAsyncResult returned by the call to BeginPutBucketTagging.
///
/// Returns a PutBucketTaggingResult from S3.
/// REST API Reference for PutBucketTagging Operation
public virtual PutBucketTaggingResponse EndPutBucketTagging(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#endregion
#region PutBucketVersioning
///
/// Sets the versioning state of an existing bucket.
///
///
///
/// You can set the versioning state with one of the following values:
///
///
///
/// Enabled—Enables versioning for the objects in the bucket. All objects added
/// to the bucket receive a unique version ID.
///
///
///
/// Suspended—Disables versioning for the objects in the bucket. All objects added
/// to the bucket receive the version ID null.
///
///
///
/// If the versioning state has never been set on a bucket, it has no versioning state;
/// a GetBucketVersioning
/// request does not return a versioning state value.
///
///
///
/// In order to enable MFA Delete, you must be the bucket owner. If you are the bucket
/// owner and want to enable MFA Delete in the bucket versioning configuration, you must
/// include the x-amz-mfa request header and the Status and
/// the MfaDelete request elements in a request to set the versioning state
/// of the bucket.
///
///
///
/// If you have an object expiration lifecycle configuration in your non-versioned bucket
/// and you want to maintain the same permanent delete behavior when you enable versioning,
/// you must add a noncurrent expiration policy. The noncurrent expiration lifecycle configuration
/// will manage the deletes of the noncurrent object versions in the version-enabled bucket.
/// (A version-enabled bucket maintains one current and zero or more noncurrent object
/// versions.) For more information, see Lifecycle
/// and Versioning.
///
///
///
/// The following operations are related to PutBucketVersioning:
///
///
///
/// Container for the necessary parameters to execute the PutBucketVersioning service method.
///
/// The response from the PutBucketVersioning service method, as returned by S3.
/// REST API Reference for PutBucketVersioning Operation
public virtual PutBucketVersioningResponse PutBucketVersioning(PutBucketVersioningRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = PutBucketVersioningRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutBucketVersioningResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the PutBucketVersioning operation.
///
///
/// Container for the necessary parameters to execute the PutBucketVersioning operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketVersioning
/// operation.
/// REST API Reference for PutBucketVersioning Operation
public virtual IAsyncResult BeginPutBucketVersioning(PutBucketVersioningRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = PutBucketVersioningRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutBucketVersioningResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the PutBucketVersioning operation.
///
///
/// The IAsyncResult returned by the call to BeginPutBucketVersioning.
///
/// Returns a PutBucketVersioningResult from S3.
/// REST API Reference for PutBucketVersioning Operation
public virtual PutBucketVersioningResponse EndPutBucketVersioning(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#endregion
#region PutBucketWebsite
///
/// Sets the configuration of the website that is specified in the website
/// subresource. To configure a bucket as a website, you can add this subresource on the
/// bucket with website configuration information such as the file name of the index document
/// and any redirect rules. For more information, see Hosting
/// Websites on Amazon S3.
///
///
///
/// This PUT action requires the S3:PutBucketWebsite permission. By default,
/// only the bucket owner can configure the website attached to a bucket; however, bucket
/// owners can allow other users to set the website configuration by writing a bucket
/// policy that grants them the S3:PutBucketWebsite permission.
///
///
///
/// To redirect all website requests sent to the bucket's website endpoint, you add a
/// website configuration with the following elements. Because all requests are sent to
/// another website, you don't need to provide index document name for the bucket.
///
/// -
///
///
WebsiteConfiguration
///
/// -
///
///
RedirectAllRequestsTo
///
/// -
///
///
HostName
///
/// -
///
///
Protocol
///
///
///
/// If you want granular control over redirects, you can use the following elements to
/// add routing rules that describe conditions for redirecting requests and information
/// about the redirect destination. In this case, the website configuration must provide
/// an index document for the bucket, because some requests might not be redirected.
///
/// -
///
///
WebsiteConfiguration
///
/// -
///
///
IndexDocument
///
/// -
///
///
Suffix
///
/// -
///
///
ErrorDocument
///
/// -
///
///
Key
///
/// -
///
///
RoutingRules
///
/// -
///
///
RoutingRule
///
/// -
///
///
Condition
///
/// -
///
///
HttpErrorCodeReturnedEquals
///
/// -
///
///
KeyPrefixEquals
///
/// -
///
///
Redirect
///
/// -
///
///
Protocol
///
/// -
///
///
HostName
///
/// -
///
///
ReplaceKeyPrefixWith
///
/// -
///
///
ReplaceKeyWith
///
/// -
///
///
HttpRedirectCode
///
///
///
/// Amazon S3 has a limitation of 50 routing rules per website configuration. If you require
/// more than 50 routing rules, you can use object redirect. For more information, see
/// Configuring
/// an Object Redirect in the Amazon S3 User Guide.
///
///
/// The bucket name.
/// Container for the request.
///
/// The response from the PutBucketWebsite service method, as returned by S3.
/// REST API Reference for PutBucketWebsite Operation
public virtual PutBucketWebsiteResponse PutBucketWebsite(string bucketName, WebsiteConfiguration websiteConfiguration)
{
var request = new PutBucketWebsiteRequest();
request.BucketName = bucketName;
request.WebsiteConfiguration = websiteConfiguration;
return PutBucketWebsite(request);
}
///
/// Sets the configuration of the website that is specified in the website
/// subresource. To configure a bucket as a website, you can add this subresource on the
/// bucket with website configuration information such as the file name of the index document
/// and any redirect rules. For more information, see Hosting
/// Websites on Amazon S3.
///
///
///
/// This PUT action requires the S3:PutBucketWebsite permission. By default,
/// only the bucket owner can configure the website attached to a bucket; however, bucket
/// owners can allow other users to set the website configuration by writing a bucket
/// policy that grants them the S3:PutBucketWebsite permission.
///
///
///
/// To redirect all website requests sent to the bucket's website endpoint, you add a
/// website configuration with the following elements. Because all requests are sent to
/// another website, you don't need to provide index document name for the bucket.
///
/// -
///
///
WebsiteConfiguration
///
/// -
///
///
RedirectAllRequestsTo
///
/// -
///
///
HostName
///
/// -
///
///
Protocol
///
///
///
/// If you want granular control over redirects, you can use the following elements to
/// add routing rules that describe conditions for redirecting requests and information
/// about the redirect destination. In this case, the website configuration must provide
/// an index document for the bucket, because some requests might not be redirected.
///
/// -
///
///
WebsiteConfiguration
///
/// -
///
///
IndexDocument
///
/// -
///
///
Suffix
///
/// -
///
///
ErrorDocument
///
/// -
///
///
Key
///
/// -
///
///
RoutingRules
///
/// -
///
///
RoutingRule
///
/// -
///
///
Condition
///
/// -
///
///
HttpErrorCodeReturnedEquals
///
/// -
///
///
KeyPrefixEquals
///
/// -
///
///
Redirect
///
/// -
///
///
Protocol
///
/// -
///
///
HostName
///
/// -
///
///
ReplaceKeyPrefixWith
///
/// -
///
///
ReplaceKeyWith
///
/// -
///
///
HttpRedirectCode
///
///
///
/// Amazon S3 has a limitation of 50 routing rules per website configuration. If you require
/// more than 50 routing rules, you can use object redirect. For more information, see
/// Configuring
/// an Object Redirect in the Amazon S3 User Guide.
///
///
/// Container for the necessary parameters to execute the PutBucketWebsite service method.
///
/// The response from the PutBucketWebsite service method, as returned by S3.
/// REST API Reference for PutBucketWebsite Operation
public virtual PutBucketWebsiteResponse PutBucketWebsite(PutBucketWebsiteRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = PutBucketWebsiteRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutBucketWebsiteResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the PutBucketWebsite operation.
///
///
/// Container for the necessary parameters to execute the PutBucketWebsite operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutBucketWebsite
/// operation.
/// REST API Reference for PutBucketWebsite Operation
public virtual IAsyncResult BeginPutBucketWebsite(PutBucketWebsiteRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = PutBucketWebsiteRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutBucketWebsiteResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the PutBucketWebsite operation.
///
///
/// The IAsyncResult returned by the call to BeginPutBucketWebsite.
///
/// Returns a PutBucketWebsiteResult from S3.
/// REST API Reference for PutBucketWebsite Operation
public virtual PutBucketWebsiteResponse EndPutBucketWebsite(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#endregion
#region PutCORSConfiguration
///
/// Sets the cors configuration for your bucket. If the configuration exists,
/// Amazon S3 replaces it.
///
///
///
/// To use this operation, you must be allowed to perform the s3:PutBucketCORS
/// action. By default, the bucket owner has this permission and can grant it to others.
///
///
///
/// You set this configuration on a bucket so that the bucket can service cross-origin
/// requests. For example, you might want to enable a request whose origin is http://www.example.com
/// to access your Amazon S3 bucket at my.example.bucket.com by using the
/// browser's XMLHttpRequest capability.
///
///
///
/// To enable cross-origin resource sharing (CORS) on a bucket, you add the cors
/// subresource to the bucket. The cors subresource is an XML document in
/// which you configure rules that identify origins and the HTTP methods that can be executed
/// on your bucket. The document is limited to 64 KB in size.
///
///
///
/// When Amazon S3 receives a cross-origin request (or a pre-flight OPTIONS request) against
/// a bucket, it evaluates the cors configuration on the bucket and uses
/// the first CORSRule rule that matches the incoming browser request to
/// enable a cross-origin request. For a rule to match, the following conditions must
/// be met:
///
/// -
///
/// The request's
Origin header must match AllowedOrigin elements.
///
/// -
///
/// The request method (for example, GET, PUT, HEAD, and so on) or the
Access-Control-Request-Method
/// header in case of a pre-flight OPTIONS request must be one of the AllowedMethod
/// elements.
///
/// -
///
/// Every header specified in the
Access-Control-Request-Headers request
/// header of a pre-flight request must match an AllowedHeader element.
///
///
///
/// For more information about CORS, go to Enabling
/// Cross-Origin Resource Sharing in the Amazon S3 User Guide.
///
///
///
/// The following operations are related to PutBucketCors:
///
///
///
/// Specifies the bucket impacted by the corsconfiguration.
/// Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more information, see Enabling Cross-Origin Resource Sharing in the Amazon S3 User Guide.
///
/// The response from the PutCORSConfiguration service method, as returned by S3.
/// REST API Reference for PutCORSConfiguration Operation
public virtual PutCORSConfigurationResponse PutCORSConfiguration(string bucketName, CORSConfiguration configuration)
{
var request = new PutCORSConfigurationRequest();
request.BucketName = bucketName;
request.Configuration = configuration;
return PutCORSConfiguration(request);
}
///
/// Sets the cors configuration for your bucket. If the configuration exists,
/// Amazon S3 replaces it.
///
///
///
/// To use this operation, you must be allowed to perform the s3:PutBucketCORS
/// action. By default, the bucket owner has this permission and can grant it to others.
///
///
///
/// You set this configuration on a bucket so that the bucket can service cross-origin
/// requests. For example, you might want to enable a request whose origin is http://www.example.com
/// to access your Amazon S3 bucket at my.example.bucket.com by using the
/// browser's XMLHttpRequest capability.
///
///
///
/// To enable cross-origin resource sharing (CORS) on a bucket, you add the cors
/// subresource to the bucket. The cors subresource is an XML document in
/// which you configure rules that identify origins and the HTTP methods that can be executed
/// on your bucket. The document is limited to 64 KB in size.
///
///
///
/// When Amazon S3 receives a cross-origin request (or a pre-flight OPTIONS request) against
/// a bucket, it evaluates the cors configuration on the bucket and uses
/// the first CORSRule rule that matches the incoming browser request to
/// enable a cross-origin request. For a rule to match, the following conditions must
/// be met:
///
/// -
///
/// The request's
Origin header must match AllowedOrigin elements.
///
/// -
///
/// The request method (for example, GET, PUT, HEAD, and so on) or the
Access-Control-Request-Method
/// header in case of a pre-flight OPTIONS request must be one of the AllowedMethod
/// elements.
///
/// -
///
/// Every header specified in the
Access-Control-Request-Headers request
/// header of a pre-flight request must match an AllowedHeader element.
///
///
///
/// For more information about CORS, go to Enabling
/// Cross-Origin Resource Sharing in the Amazon S3 User Guide.
///
///
///
/// The following operations are related to PutBucketCors:
///
///
///
/// Container for the necessary parameters to execute the PutCORSConfiguration service method.
///
/// The response from the PutCORSConfiguration service method, as returned by S3.
/// REST API Reference for PutCORSConfiguration Operation
public virtual PutCORSConfigurationResponse PutCORSConfiguration(PutCORSConfigurationRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = PutCORSConfigurationRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutCORSConfigurationResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the PutCORSConfiguration operation.
///
///
/// Container for the necessary parameters to execute the PutCORSConfiguration operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutCORSConfiguration
/// operation.
/// REST API Reference for PutCORSConfiguration Operation
public virtual IAsyncResult BeginPutCORSConfiguration(PutCORSConfigurationRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = PutCORSConfigurationRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutCORSConfigurationResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the PutCORSConfiguration operation.
///
///
/// The IAsyncResult returned by the call to BeginPutCORSConfiguration.
///
/// Returns a PutCORSConfigurationResult from S3.
/// REST API Reference for PutCORSConfiguration Operation
public virtual PutCORSConfigurationResponse EndPutCORSConfiguration(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#endregion
#region PutLifecycleConfiguration
///
/// Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle
/// configuration. Keep in mind that this will overwrite an existing lifecycle configuration,
/// so if you want to retain any configuration details, they must be included in the new
/// lifecycle configuration. For information about lifecycle configuration, see Managing
/// your storage lifecycle.
///
///
///
/// Bucket lifecycle configuration now supports specifying a lifecycle rule using an object
/// key name prefix, one or more object tags, or a combination of both. Accordingly, this
/// section describes the latest API. The previous version of the API supported filtering
/// based only on an object key name prefix, which is supported for backward compatibility.
/// For the related API description, see PutBucketLifecycle.
///
/// - Rules
-
///
/// You specify the lifecycle configuration in your request body. The lifecycle configuration
/// is specified as XML consisting of one or more rules. An Amazon S3 Lifecycle configuration
/// can have up to 1,000 rules. This limit is not adjustable. Each rule consists of the
/// following:
///
///
-
///
/// A filter identifying a subset of objects to which the rule applies. The filter can
/// be based on a key name prefix, object tags, or a combination of both.
///
///
-
///
/// A status indicating whether the rule is in effect.
///
///
-
///
/// One or more lifecycle transition and expiration actions that you want Amazon S3 to
/// perform on the objects identified by the filter. If the state of your bucket is versioning-enabled
/// or versioning-suspended, you can have many versions of the same object (one current
/// version and zero or more noncurrent versions). Amazon S3 provides predefined actions
/// that you can specify for current and noncurrent object versions.
///
///
///
/// For more information, see Object
/// Lifecycle Management and Lifecycle
/// Configuration Elements.
///
/// - Permissions
-
///
/// By default, all Amazon S3 resources are private, including buckets, objects, and related
/// subresources (for example, lifecycle configuration and website configuration). Only
/// the resource owner (that is, the Amazon Web Services account that created it) can
/// access the resource. The resource owner can optionally grant access permissions to
/// others by writing an access policy. For this operation, a user must get the
s3:PutLifecycleConfiguration
/// permission.
///
///
///
/// You can also explicitly deny permissions. An explicit deny also supersedes any other
/// permissions. If you want to block users or accounts from removing or deleting objects
/// from your bucket, you must deny them permissions for the following actions:
///
/// -
///
///
s3:DeleteObject
///
/// -
///
///
s3:DeleteObjectVersion
///
/// -
///
///
s3:PutLifecycleConfiguration
///
///
///
/// For more information about permissions, see Managing
/// Access Permissions to Your Amazon S3 Resources.
///
///
///
/// The following operations are related to PutBucketLifecycleConfiguration:
///
///
///
/// The name of the bucket for which to set the configuration.
/// A property of PutLifecycleConfigurationRequest used to execute the PutLifecycleConfiguration service method.
///
/// The response from the PutLifecycleConfiguration service method, as returned by S3.
/// REST API Reference for PutLifecycleConfiguration Operation
public virtual PutLifecycleConfigurationResponse PutLifecycleConfiguration(string bucketName, LifecycleConfiguration configuration)
{
var request = new PutLifecycleConfigurationRequest();
request.BucketName = bucketName;
request.Configuration = configuration;
return PutLifecycleConfiguration(request);
}
///
/// Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle
/// configuration. Keep in mind that this will overwrite an existing lifecycle configuration,
/// so if you want to retain any configuration details, they must be included in the new
/// lifecycle configuration. For information about lifecycle configuration, see Managing
/// your storage lifecycle.
///
///
///
/// Bucket lifecycle configuration now supports specifying a lifecycle rule using an object
/// key name prefix, one or more object tags, or a combination of both. Accordingly, this
/// section describes the latest API. The previous version of the API supported filtering
/// based only on an object key name prefix, which is supported for backward compatibility.
/// For the related API description, see PutBucketLifecycle.
///
/// - Rules
-
///
/// You specify the lifecycle configuration in your request body. The lifecycle configuration
/// is specified as XML consisting of one or more rules. An Amazon S3 Lifecycle configuration
/// can have up to 1,000 rules. This limit is not adjustable. Each rule consists of the
/// following:
///
///
-
///
/// A filter identifying a subset of objects to which the rule applies. The filter can
/// be based on a key name prefix, object tags, or a combination of both.
///
///
-
///
/// A status indicating whether the rule is in effect.
///
///
-
///
/// One or more lifecycle transition and expiration actions that you want Amazon S3 to
/// perform on the objects identified by the filter. If the state of your bucket is versioning-enabled
/// or versioning-suspended, you can have many versions of the same object (one current
/// version and zero or more noncurrent versions). Amazon S3 provides predefined actions
/// that you can specify for current and noncurrent object versions.
///
///
///
/// For more information, see Object
/// Lifecycle Management and Lifecycle
/// Configuration Elements.
///
/// - Permissions
-
///
/// By default, all Amazon S3 resources are private, including buckets, objects, and related
/// subresources (for example, lifecycle configuration and website configuration). Only
/// the resource owner (that is, the Amazon Web Services account that created it) can
/// access the resource. The resource owner can optionally grant access permissions to
/// others by writing an access policy. For this operation, a user must get the
s3:PutLifecycleConfiguration
/// permission.
///
///
///
/// You can also explicitly deny permissions. An explicit deny also supersedes any other
/// permissions. If you want to block users or accounts from removing or deleting objects
/// from your bucket, you must deny them permissions for the following actions:
///
/// -
///
///
s3:DeleteObject
///
/// -
///
///
s3:DeleteObjectVersion
///
/// -
///
///
s3:PutLifecycleConfiguration
///
///
///
/// For more information about permissions, see Managing
/// Access Permissions to Your Amazon S3 Resources.
///
///
///
/// The following operations are related to PutBucketLifecycleConfiguration:
///
///
///
/// Container for the necessary parameters to execute the PutLifecycleConfiguration service method.
///
/// The response from the PutLifecycleConfiguration service method, as returned by S3.
/// REST API Reference for PutLifecycleConfiguration Operation
public virtual PutLifecycleConfigurationResponse PutLifecycleConfiguration(PutLifecycleConfigurationRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = PutLifecycleConfigurationRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutLifecycleConfigurationResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the PutLifecycleConfiguration operation.
///
///
/// Container for the necessary parameters to execute the PutLifecycleConfiguration operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutLifecycleConfiguration
/// operation.
/// REST API Reference for PutLifecycleConfiguration Operation
public virtual IAsyncResult BeginPutLifecycleConfiguration(PutLifecycleConfigurationRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = PutLifecycleConfigurationRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutLifecycleConfigurationResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the PutLifecycleConfiguration operation.
///
///
/// The IAsyncResult returned by the call to BeginPutLifecycleConfiguration.
///
/// Returns a PutLifecycleConfigurationResult from S3.
/// REST API Reference for PutLifecycleConfiguration Operation
public virtual PutLifecycleConfigurationResponse EndPutLifecycleConfiguration(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#endregion
#region PutObject
///
/// Adds an object to a bucket. You must have WRITE permissions on a bucket to add an
/// object to it.
///
///
///
/// Amazon S3 never adds partial objects; if you receive a success response, Amazon S3
/// added the entire object to the bucket. You cannot use PutObject to only
/// update a single piece of metadata for an existing object. You must put the entire
/// object with updated metadata if you want to update some values.
///
///
///
/// Amazon S3 is a distributed system. If it receives multiple write requests for the
/// same object simultaneously, it overwrites all but the last object written. To prevent
/// objects from being deleted or overwritten, you can use Amazon
/// S3 Object Lock.
///
///
///
/// To ensure that data is not corrupted traversing the network, use the Content-MD5
/// header. When you use this header, Amazon S3 checks the object against the provided
/// MD5 value and, if they do not match, returns an error. Additionally, you can calculate
/// the MD5 while putting an object to Amazon S3 and compare the returned ETag to the
/// calculated MD5 value.
///
/// -
///
/// To successfully complete the
PutObject request, you must have the s3:PutObject
/// in your IAM permissions.
///
/// -
///
/// To successfully change the objects acl of your
PutObject request, you
/// must have the s3:PutObjectAcl in your IAM permissions.
///
/// -
///
/// To successfully set the tag-set with your
PutObject request, you must
/// have the s3:PutObjectTagging in your IAM permissions.
///
/// -
///
/// The
Content-MD5 header is required for any request to upload an object
/// with a retention period configured using Amazon S3 Object Lock. For more information
/// about Amazon S3 Object Lock, see Amazon
/// S3 Object Lock Overview in the Amazon S3 User Guide.
///
///
///
/// You have four mutually exclusive options to protect data using server-side encryption
/// in Amazon S3, depending on how you choose to manage the encryption keys. Specifically,
/// the encryption key options are Amazon S3 managed keys (SSE-S3), Amazon Web Services
/// KMS keys (SSE-KMS or DSSE-KMS), and customer-provided keys (SSE-C). Amazon S3 encrypts
/// data with server-side encryption by using Amazon S3 managed keys (SSE-S3) by default.
/// You can optionally tell Amazon S3 to encrypt data at rest by using server-side encryption
/// with other key options. For more information, see Using
/// Server-Side Encryption.
///
///
///
/// When adding a new object, you can use headers to grant ACL-based permissions to individual
/// Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions
/// are then added to the ACL on the object. By default, all objects are private. Only
/// the owner has full access control. For more information, see Access
/// Control List (ACL) Overview and Managing
/// ACLs Using the REST API.
///
///
///
/// If the bucket that you're uploading objects to uses the bucket owner enforced setting
/// for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets
/// that use this setting only accept PUT requests that don't specify an ACL or PUT requests
/// that specify bucket owner full control ACLs, such as the bucket-owner-full-control
/// canned ACL or an equivalent form of this ACL expressed in the XML format. PUT requests
/// that contain other ACLs (for example, custom grants to certain Amazon Web Services
/// accounts) fail and return a 400 error with the error code AccessControlListNotSupported.
/// For more information, see
/// Controlling ownership of objects and disabling ACLs in the Amazon S3 User Guide.
///
///
///
/// 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.
///
///
///
/// By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects.
/// The STANDARD storage class provides high durability and high availability. Depending
/// on performance needs, you can specify a different Storage Class. Amazon S3 on Outposts
/// only uses the OUTPOSTS Storage Class. For more information, see Storage
/// Classes in the Amazon S3 User Guide.
///
///
///
/// If you enable versioning for a bucket, Amazon S3 automatically generates a unique
/// version ID for the object being stored. Amazon S3 returns this ID in the response.
/// When you enable versioning for a bucket, if Amazon S3 receives multiple write requests
/// for the same object simultaneously, it stores all of the objects. For more information
/// about versioning, see Adding
/// Objects to Versioning-Enabled Buckets. For information about returning the versioning
/// state of a bucket, see GetBucketVersioning.
///
///
///
///
/// For more information about related Amazon S3 APIs, see the following:
///
///
///
/// Container for the necessary parameters to execute the PutObject service method.
///
/// The response from the PutObject service method, as returned by S3.
/// REST API Reference for PutObject Operation
public virtual PutObjectResponse PutObject(PutObjectRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = PutObjectRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutObjectResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the PutObject operation.
///
///
/// Container for the necessary parameters to execute the PutObject operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutObject
/// operation.
/// REST API Reference for PutObject Operation
public virtual IAsyncResult BeginPutObject(PutObjectRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = PutObjectRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutObjectResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the PutObject operation.
///
///
/// The IAsyncResult returned by the call to BeginPutObject.
///
/// Returns a PutObjectResult from S3.
/// REST API Reference for PutObject Operation
public virtual PutObjectResponse EndPutObject(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#endregion
#region PutObjectLegalHold
///
/// Applies a legal hold configuration to the specified object. For more information,
/// see Locking
/// Objects.
///
///
///
/// This action is not supported by Amazon S3 on Outposts.
///
///
/// Container for the necessary parameters to execute the PutObjectLegalHold service method.
///
/// The response from the PutObjectLegalHold service method, as returned by S3.
/// REST API Reference for PutObjectLegalHold Operation
public virtual PutObjectLegalHoldResponse PutObjectLegalHold(PutObjectLegalHoldRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = PutObjectLegalHoldRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutObjectLegalHoldResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the PutObjectLegalHold operation.
///
///
/// Container for the necessary parameters to execute the PutObjectLegalHold operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutObjectLegalHold
/// operation.
/// REST API Reference for PutObjectLegalHold Operation
public virtual IAsyncResult BeginPutObjectLegalHold(PutObjectLegalHoldRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = PutObjectLegalHoldRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutObjectLegalHoldResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the PutObjectLegalHold operation.
///
///
/// The IAsyncResult returned by the call to BeginPutObjectLegalHold.
///
/// Returns a PutObjectLegalHoldResult from S3.
/// REST API Reference for PutObjectLegalHold Operation
public virtual PutObjectLegalHoldResponse EndPutObjectLegalHold(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#endregion
#region PutObjectLockConfiguration
///
/// Places an Object Lock configuration on the specified bucket. The rule specified in
/// the Object Lock configuration will be applied by default to every new object placed
/// in the specified bucket. For more information, see Locking
/// Objects.
///
/// -
///
/// The
DefaultRetention settings require both a mode and a period.
///
/// -
///
/// The
DefaultRetention period can be either Days or Years
/// but you must select one. You cannot specify Days and Years
/// at the same time.
///
/// -
///
/// You can only enable Object Lock for new buckets. If you want to turn on Object Lock
/// for an existing bucket, contact Amazon Web Services Support.
///
///
///
/// Container for the necessary parameters to execute the PutObjectLockConfiguration service method.
///
/// The response from the PutObjectLockConfiguration service method, as returned by S3.
/// REST API Reference for PutObjectLockConfiguration Operation
public virtual PutObjectLockConfigurationResponse PutObjectLockConfiguration(PutObjectLockConfigurationRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = PutObjectLockConfigurationRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutObjectLockConfigurationResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the PutObjectLockConfiguration operation.
///
///
/// Container for the necessary parameters to execute the PutObjectLockConfiguration operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutObjectLockConfiguration
/// operation.
/// REST API Reference for PutObjectLockConfiguration Operation
public virtual IAsyncResult BeginPutObjectLockConfiguration(PutObjectLockConfigurationRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = PutObjectLockConfigurationRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutObjectLockConfigurationResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the PutObjectLockConfiguration operation.
///
///
/// The IAsyncResult returned by the call to BeginPutObjectLockConfiguration.
///
/// Returns a PutObjectLockConfigurationResult from S3.
/// REST API Reference for PutObjectLockConfiguration Operation
public virtual PutObjectLockConfigurationResponse EndPutObjectLockConfiguration(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#endregion
#region PutObjectRetention
///
/// Places an Object Retention configuration on an object. For more information, see Locking Objects.
/// Users or accounts require the s3:PutObjectRetention permission in order
/// to place an Object Retention configuration on objects. Bypassing a Governance Retention
/// configuration requires the s3:BypassGovernanceRetention permission.
///
///
///
/// This action is not supported by Amazon S3 on Outposts.
///
///
/// Container for the necessary parameters to execute the PutObjectRetention service method.
///
/// The response from the PutObjectRetention service method, as returned by S3.
/// REST API Reference for PutObjectRetention Operation
public virtual PutObjectRetentionResponse PutObjectRetention(PutObjectRetentionRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = PutObjectRetentionRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutObjectRetentionResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the PutObjectRetention operation.
///
///
/// Container for the necessary parameters to execute the PutObjectRetention operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutObjectRetention
/// operation.
/// REST API Reference for PutObjectRetention Operation
public virtual IAsyncResult BeginPutObjectRetention(PutObjectRetentionRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = PutObjectRetentionRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutObjectRetentionResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the PutObjectRetention operation.
///
///
/// The IAsyncResult returned by the call to BeginPutObjectRetention.
///
/// Returns a PutObjectRetentionResult from S3.
/// REST API Reference for PutObjectRetention Operation
public virtual PutObjectRetentionResponse EndPutObjectRetention(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#endregion
#region PutObjectTagging
///
/// Sets the supplied tag-set to an object that already exists in a bucket.
///
///
///
/// A tag is a key-value pair. You can associate tags with an object by sending a PUT
/// request against the tagging subresource that is associated with the object. You can
/// retrieve tags by sending a GET request. For more information, see GetObjectTagging.
///
///
///
/// For tagging-related restrictions related to characters and encodings, see Tag
/// Restrictions. Note that Amazon S3 limits the maximum number of tags to 10 tags
/// per object.
///
///
///
/// To use this operation, you must have permission to perform the s3:PutObjectTagging
/// action. By default, the bucket owner has this permission and can grant this permission
/// to others.
///
///
///
/// To put tags of any other version, use the versionId query parameter.
/// You also need permission for the s3:PutObjectVersionTagging action.
///
///
///
/// For information about the Amazon S3 object tagging feature, see Object
/// Tagging.
///
///
///
/// PutObjectTagging has the following special errors:
///
/// -
-
///
/// Code: InvalidTagError
///
///
-
///
/// Cause: The tag provided was not a valid tag. This error can occur if the tag did
/// not pass input validation. For more information, see Object
/// Tagging.
///
///
-
-
///
/// Code: MalformedXMLError
///
///
-
///
/// Cause: The XML provided does not match the schema.
///
///
-
-
///
/// Code: OperationAbortedError
///
///
-
///
/// Cause: A conflicting conditional action is currently in progress against this
/// resource. Please try again.
///
///
-
-
///
/// Code: InternalError
///
///
-
///
/// Cause: The service was unable to apply the provided tag to the object.
///
///
///
/// The following operations are related to PutObjectTagging:
///
///
///
/// Container for the necessary parameters to execute the PutObjectTagging service method.
///
/// The response from the PutObjectTagging service method, as returned by S3.
/// REST API Reference for PutObjectTagging Operation
public virtual PutObjectTaggingResponse PutObjectTagging(PutObjectTaggingRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = PutObjectTaggingRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutObjectTaggingResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the PutObjectTagging operation.
///
///
/// Container for the necessary parameters to execute the PutObjectTagging operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutObjectTagging
/// operation.
/// REST API Reference for PutObjectTagging Operation
public virtual IAsyncResult BeginPutObjectTagging(PutObjectTaggingRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = PutObjectTaggingRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutObjectTaggingResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the PutObjectTagging operation.
///
///
/// The IAsyncResult returned by the call to BeginPutObjectTagging.
///
/// Returns a PutObjectTaggingResult from S3.
/// REST API Reference for PutObjectTagging Operation
public virtual PutObjectTaggingResponse EndPutObjectTagging(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#endregion
#region PutPublicAccessBlock
///
/// Creates or modifies the PublicAccessBlock configuration for an Amazon
/// S3 bucket. To use this operation, you must have the s3:PutBucketPublicAccessBlock
/// permission. For more information about Amazon S3 permissions, see Specifying
/// Permissions in a Policy.
///
///
///
/// When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket
/// or an object, it checks the PublicAccessBlock configuration for both
/// the bucket (or the bucket that contains the object) and the bucket owner's account.
/// If the PublicAccessBlock configurations are different between the bucket
/// and the account, Amazon S3 uses the most restrictive combination of the bucket-level
/// and account-level settings.
///
///
///
/// For more information about when Amazon S3 considers a bucket or an object public,
/// see The
/// Meaning of "Public".
///
///
///
/// The following operations are related to PutPublicAccessBlock:
///
///
///
/// Container for the necessary parameters to execute the PutPublicAccessBlock service method.
///
/// The response from the PutPublicAccessBlock service method, as returned by S3.
/// REST API Reference for PutPublicAccessBlock Operation
public virtual PutPublicAccessBlockResponse PutPublicAccessBlock(PutPublicAccessBlockRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = PutPublicAccessBlockRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutPublicAccessBlockResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the PutPublicAccessBlock operation.
///
///
/// Container for the necessary parameters to execute the PutPublicAccessBlock operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutPublicAccessBlock
/// operation.
/// REST API Reference for PutPublicAccessBlock Operation
public virtual IAsyncResult BeginPutPublicAccessBlock(PutPublicAccessBlockRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = PutPublicAccessBlockRequestMarshaller.Instance;
options.ResponseUnmarshaller = PutPublicAccessBlockResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the PutPublicAccessBlock operation.
///
///
/// The IAsyncResult returned by the call to BeginPutPublicAccessBlock.
///
/// Returns a PutPublicAccessBlockResult from S3.
/// REST API Reference for PutPublicAccessBlock Operation
public virtual PutPublicAccessBlockResponse EndPutPublicAccessBlock(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#endregion
#region RestoreObject
///
/// Restores an archived copy of an object back into Amazon S3
///
///
///
/// This action is not supported by Amazon S3 on Outposts.
///
///
///
/// This action performs the following types of requests:
///
/// -
///
///
select - Perform a select query on an archived object
///
/// -
///
///
restore an archive - Restore an archived object
///
///
///
/// For more information about the S3 structure in the request body, see
/// the following:
///
///
///
/// Define the SQL expression for the SELECT type of restoration for your
/// query in the request body's SelectParameters structure. You can use expressions
/// like the following examples.
///
/// -
///
/// The following expression returns all records from the specified object.
///
///
///
///
SELECT * FROM Object
///
/// -
///
/// Assuming that you are not using any headers for data stored in the object, you can
/// specify columns with positional headers.
///
///
///
///
SELECT s._1, s._2 FROM Object s WHERE s._3 > 100
///
/// -
///
/// If you have headers and you set the
fileHeaderInfo in the CSV
/// structure in the request body to USE, you can specify headers in the
/// query. (If you set the fileHeaderInfo field to IGNORE, the
/// first row is skipped for the query.) You cannot mix ordinal positions with header
/// column names.
///
///
///
/// SELECT s.Id, s.FirstName, s.SSN FROM S3Object s
///
///
///
/// When making a select request, you can also do the following:
///
/// -
///
/// To expedite your queries, specify the
Expedited tier. For more information
/// about tiers, see "Restoring Archives," later in this topic.
///
/// -
///
/// Specify details about the data serialization format of both the input object that
/// is being queried and the serialization of the CSV-encoded query results.
///
///
///
/// The following are additional important facts about the select feature:
///
/// -
///
/// The output results are new Amazon S3 objects. Unlike archive retrievals, they are
/// stored until explicitly deleted-manually or through a lifecycle configuration.
///
///
-
///
/// You can issue more than one select request on the same Amazon S3 object. Amazon S3
/// doesn't duplicate requests, so avoid issuing duplicate requests.
///
///
-
///
/// Amazon S3 accepts a select request even if the object has already been restored.
/// A select request doesn’t return error response
409.
///
///
- Permissions
-
///
/// To use this operation, you must have permissions to perform the
s3:RestoreObject
/// action. The bucket owner has this permission by default and can grant this permission
/// to others. For more information about permissions, see Permissions
/// Related to Bucket Subresource Operations and Managing
/// Access Permissions to Your Amazon S3 Resources in the Amazon S3 User Guide.
///
/// - Restoring objects
-
///
/// Objects that you archive to the S3 Glacier Flexible Retrieval Flexible Retrieval or
/// S3 Glacier Deep Archive storage class, and S3 Intelligent-Tiering Archive or S3 Intelligent-Tiering
/// Deep Archive tiers, are not accessible in real time. For objects in the S3 Glacier
/// Flexible Retrieval Flexible Retrieval or S3 Glacier Deep Archive storage classes,
/// you must first initiate a restore request, and then wait until a temporary copy of
/// the object is available. If you want a permanent copy of the object, create a copy
/// of it in the Amazon S3 Standard storage class in your S3 bucket. To access an archived
/// object, you must restore the object for the duration (number of days) that you specify.
/// For objects in the Archive Access or Deep Archive Access tiers of S3 Intelligent-Tiering,
/// you must first initiate a restore request, and then wait until the object is moved
/// into the Frequent Access tier.
///
///
///
/// To restore a specific object version, you can provide a version ID. If you don't provide
/// a version ID, Amazon S3 restores the current version.
///
///
///
/// When restoring an archived object, you can specify one of the following data access
/// tier options in the
Tier element of the request body:
///
/// -
///
///
Expedited - Expedited retrievals allow you to quickly access your data
/// stored in the S3 Glacier Flexible Retrieval Flexible Retrieval storage class or S3
/// Intelligent-Tiering Archive tier when occasional urgent requests for restoring archives
/// are required. For all but the largest archived objects (250 MB+), data accessed using
/// Expedited retrievals is typically made available within 1–5 minutes. Provisioned capacity
/// ensures that retrieval capacity for Expedited retrievals is available when you need
/// it. Expedited retrievals and provisioned capacity are not available for objects stored
/// in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive
/// tier.
///
/// -
///
///
Standard - Standard retrievals allow you to access any of your archived
/// objects within several hours. This is the default option for retrieval requests that
/// do not specify the retrieval option. Standard retrievals typically finish within 3–5
/// hours for objects stored in the S3 Glacier Flexible Retrieval Flexible Retrieval storage
/// class or S3 Intelligent-Tiering Archive tier. They typically finish within 12 hours
/// for objects stored in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering
/// Deep Archive tier. Standard retrievals are free for objects stored in S3 Intelligent-Tiering.
///
/// -
///
///
Bulk - Bulk retrievals free for objects stored in the S3 Glacier Flexible
/// Retrieval and S3 Intelligent-Tiering storage classes, enabling you to retrieve large
/// amounts, even petabytes, of data at no cost. Bulk retrievals typically finish within
/// 5–12 hours for objects stored in the S3 Glacier Flexible Retrieval Flexible Retrieval
/// storage class or S3 Intelligent-Tiering Archive tier. Bulk retrievals are also the
/// lowest-cost retrieval option when restoring objects from S3 Glacier Deep Archive.
/// They typically finish within 48 hours for objects stored in the S3 Glacier Deep Archive
/// storage class or S3 Intelligent-Tiering Deep Archive tier.
///
///
///
/// For more information about archive retrieval options and provisioned capacity for
/// Expedited data access, see Restoring
/// Archived Objects in the Amazon S3 User Guide.
///
///
///
/// You can use Amazon S3 restore speed upgrade to change the restore speed to a faster
/// speed while it is in progress. For more information, see
/// Upgrading the speed of an in-progress restore in the Amazon S3 User Guide.
///
///
///
///
/// To get the status of object restoration, you can send a HEAD request.
/// Operations return the x-amz-restore header, which provides information
/// about the restoration status, in the response. You can use Amazon S3 event notifications
/// to notify you when a restore is initiated or completed. For more information, see
/// Configuring
/// Amazon S3 Event Notifications in the Amazon S3 User Guide.
///
///
///
/// After restoring an archived object, you can update the restoration period by reissuing
/// the request with a new period. Amazon S3 updates the restoration period relative to
/// the current time and charges only for the request-there are no data transfer charges.
/// You cannot update the restoration period when Amazon S3 is actively processing your
/// current restore request for the object.
///
///
///
/// If your bucket has a lifecycle configuration with a rule that includes an expiration
/// action, the object expiration overrides the life span that you specify in a restore
/// request. For example, if you restore an object copy for 10 days, but the object is
/// scheduled to expire in 3 days, Amazon S3 deletes the object in 3 days. For more information
/// about lifecycle configuration, see PutBucketLifecycleConfiguration
/// and Object
/// Lifecycle Management in Amazon S3 User Guide.
///
/// - Responses
-
///
/// A successful action returns either the
200 OK or 202 Accepted
/// status code.
///
/// -
///
/// If the object is not previously restored, then Amazon S3 returns
202 Accepted
/// in the response.
///
/// -
///
/// If the object is previously restored, Amazon S3 returns
200 OK in the
/// response.
///
///
-
///
/// Special errors:
///
///
-
///
/// Code: RestoreAlreadyInProgress
///
///
-
///
/// Cause: Object restore is already in progress. (This error does not apply to SELECT
/// type requests.)
///
///
-
///
/// HTTP Status Code: 409 Conflict
///
///
-
///
/// SOAP Fault Code Prefix: Client
///
///
-
-
///
/// Code: GlacierExpeditedRetrievalNotAvailable
///
///
-
///
/// Cause: expedited retrievals are currently not available. Try again later. (Returned
/// if there is insufficient capacity to process the Expedited request. This error applies
/// only to Expedited retrievals and not to S3 Standard or Bulk retrievals.)
///
///
-
///
/// HTTP Status Code: 503
///
///
-
///
/// SOAP Fault Code Prefix: N/A
///
///
///
/// The following operations are related to RestoreObject:
///
///
///
/// The bucket name containing the object to restore. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form 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 action was initiated.
///
/// The response from the RestoreObject service method, as returned by S3.
/// REST API Reference for RestoreObject Operation
public virtual RestoreObjectResponse RestoreObject(string bucketName, string key)
{
var request = new RestoreObjectRequest();
request.BucketName = bucketName;
request.Key = key;
return RestoreObject(request);
}
///
/// Restores an archived copy of an object back into Amazon S3
///
///
///
/// This action is not supported by Amazon S3 on Outposts.
///
///
///
/// This action performs the following types of requests:
///
/// -
///
///
select - Perform a select query on an archived object
///
/// -
///
///
restore an archive - Restore an archived object
///
///
///
/// For more information about the S3 structure in the request body, see
/// the following:
///
///
///
/// Define the SQL expression for the SELECT type of restoration for your
/// query in the request body's SelectParameters structure. You can use expressions
/// like the following examples.
///
/// -
///
/// The following expression returns all records from the specified object.
///
///
///
///
SELECT * FROM Object
///
/// -
///
/// Assuming that you are not using any headers for data stored in the object, you can
/// specify columns with positional headers.
///
///
///
///
SELECT s._1, s._2 FROM Object s WHERE s._3 > 100
///
/// -
///
/// If you have headers and you set the
fileHeaderInfo in the CSV
/// structure in the request body to USE, you can specify headers in the
/// query. (If you set the fileHeaderInfo field to IGNORE, the
/// first row is skipped for the query.) You cannot mix ordinal positions with header
/// column names.
///
///
///
/// SELECT s.Id, s.FirstName, s.SSN FROM S3Object s
///
///
///
/// When making a select request, you can also do the following:
///
/// -
///
/// To expedite your queries, specify the
Expedited tier. For more information
/// about tiers, see "Restoring Archives," later in this topic.
///
/// -
///
/// Specify details about the data serialization format of both the input object that
/// is being queried and the serialization of the CSV-encoded query results.
///
///
///
/// The following are additional important facts about the select feature:
///
/// -
///
/// The output results are new Amazon S3 objects. Unlike archive retrievals, they are
/// stored until explicitly deleted-manually or through a lifecycle configuration.
///
///
-
///
/// You can issue more than one select request on the same Amazon S3 object. Amazon S3
/// doesn't duplicate requests, so avoid issuing duplicate requests.
///
///
-
///
/// Amazon S3 accepts a select request even if the object has already been restored.
/// A select request doesn’t return error response
409.
///
///
- Permissions
-
///
/// To use this operation, you must have permissions to perform the
s3:RestoreObject
/// action. The bucket owner has this permission by default and can grant this permission
/// to others. For more information about permissions, see Permissions
/// Related to Bucket Subresource Operations and Managing
/// Access Permissions to Your Amazon S3 Resources in the Amazon S3 User Guide.
///
/// - Restoring objects
-
///
/// Objects that you archive to the S3 Glacier Flexible Retrieval Flexible Retrieval or
/// S3 Glacier Deep Archive storage class, and S3 Intelligent-Tiering Archive or S3 Intelligent-Tiering
/// Deep Archive tiers, are not accessible in real time. For objects in the S3 Glacier
/// Flexible Retrieval Flexible Retrieval or S3 Glacier Deep Archive storage classes,
/// you must first initiate a restore request, and then wait until a temporary copy of
/// the object is available. If you want a permanent copy of the object, create a copy
/// of it in the Amazon S3 Standard storage class in your S3 bucket. To access an archived
/// object, you must restore the object for the duration (number of days) that you specify.
/// For objects in the Archive Access or Deep Archive Access tiers of S3 Intelligent-Tiering,
/// you must first initiate a restore request, and then wait until the object is moved
/// into the Frequent Access tier.
///
///
///
/// To restore a specific object version, you can provide a version ID. If you don't provide
/// a version ID, Amazon S3 restores the current version.
///
///
///
/// When restoring an archived object, you can specify one of the following data access
/// tier options in the
Tier element of the request body:
///
/// -
///
///
Expedited - Expedited retrievals allow you to quickly access your data
/// stored in the S3 Glacier Flexible Retrieval Flexible Retrieval storage class or S3
/// Intelligent-Tiering Archive tier when occasional urgent requests for restoring archives
/// are required. For all but the largest archived objects (250 MB+), data accessed using
/// Expedited retrievals is typically made available within 1–5 minutes. Provisioned capacity
/// ensures that retrieval capacity for Expedited retrievals is available when you need
/// it. Expedited retrievals and provisioned capacity are not available for objects stored
/// in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive
/// tier.
///
/// -
///
///
Standard - Standard retrievals allow you to access any of your archived
/// objects within several hours. This is the default option for retrieval requests that
/// do not specify the retrieval option. Standard retrievals typically finish within 3–5
/// hours for objects stored in the S3 Glacier Flexible Retrieval Flexible Retrieval storage
/// class or S3 Intelligent-Tiering Archive tier. They typically finish within 12 hours
/// for objects stored in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering
/// Deep Archive tier. Standard retrievals are free for objects stored in S3 Intelligent-Tiering.
///
/// -
///
///
Bulk - Bulk retrievals free for objects stored in the S3 Glacier Flexible
/// Retrieval and S3 Intelligent-Tiering storage classes, enabling you to retrieve large
/// amounts, even petabytes, of data at no cost. Bulk retrievals typically finish within
/// 5–12 hours for objects stored in the S3 Glacier Flexible Retrieval Flexible Retrieval
/// storage class or S3 Intelligent-Tiering Archive tier. Bulk retrievals are also the
/// lowest-cost retrieval option when restoring objects from S3 Glacier Deep Archive.
/// They typically finish within 48 hours for objects stored in the S3 Glacier Deep Archive
/// storage class or S3 Intelligent-Tiering Deep Archive tier.
///
///
///
/// For more information about archive retrieval options and provisioned capacity for
/// Expedited data access, see Restoring
/// Archived Objects in the Amazon S3 User Guide.
///
///
///
/// You can use Amazon S3 restore speed upgrade to change the restore speed to a faster
/// speed while it is in progress. For more information, see
/// Upgrading the speed of an in-progress restore in the Amazon S3 User Guide.
///
///
///
///
/// To get the status of object restoration, you can send a HEAD request.
/// Operations return the x-amz-restore header, which provides information
/// about the restoration status, in the response. You can use Amazon S3 event notifications
/// to notify you when a restore is initiated or completed. For more information, see
/// Configuring
/// Amazon S3 Event Notifications in the Amazon S3 User Guide.
///
///
///
/// After restoring an archived object, you can update the restoration period by reissuing
/// the request with a new period. Amazon S3 updates the restoration period relative to
/// the current time and charges only for the request-there are no data transfer charges.
/// You cannot update the restoration period when Amazon S3 is actively processing your
/// current restore request for the object.
///
///
///
/// If your bucket has a lifecycle configuration with a rule that includes an expiration
/// action, the object expiration overrides the life span that you specify in a restore
/// request. For example, if you restore an object copy for 10 days, but the object is
/// scheduled to expire in 3 days, Amazon S3 deletes the object in 3 days. For more information
/// about lifecycle configuration, see PutBucketLifecycleConfiguration
/// and Object
/// Lifecycle Management in Amazon S3 User Guide.
///
/// - Responses
-
///
/// A successful action returns either the
200 OK or 202 Accepted
/// status code.
///
/// -
///
/// If the object is not previously restored, then Amazon S3 returns
202 Accepted
/// in the response.
///
/// -
///
/// If the object is previously restored, Amazon S3 returns
200 OK in the
/// response.
///
///
-
///
/// Special errors:
///
///
-
///
/// Code: RestoreAlreadyInProgress
///
///
-
///
/// Cause: Object restore is already in progress. (This error does not apply to SELECT
/// type requests.)
///
///
-
///
/// HTTP Status Code: 409 Conflict
///
///
-
///
/// SOAP Fault Code Prefix: Client
///
///
-
-
///
/// Code: GlacierExpeditedRetrievalNotAvailable
///
///
-
///
/// Cause: expedited retrievals are currently not available. Try again later. (Returned
/// if there is insufficient capacity to process the Expedited request. This error applies
/// only to Expedited retrievals and not to S3 Standard or Bulk retrievals.)
///
///
-
///
/// HTTP Status Code: 503
///
///
-
///
/// SOAP Fault Code Prefix: N/A
///
///
///
/// The following operations are related to RestoreObject:
///
///
///
/// The bucket name containing the object to restore. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form 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 action was initiated.
/// A property of RestoreObjectRequest used to execute the RestoreObject service method.
///
/// The response from the RestoreObject service method, as returned by S3.
/// REST API Reference for RestoreObject Operation
public virtual RestoreObjectResponse RestoreObject(string bucketName, string key, int days)
{
var request = new RestoreObjectRequest();
request.BucketName = bucketName;
request.Key = key;
request.Days = days;
return RestoreObject(request);
}
///
/// Restores an archived copy of an object back into Amazon S3
///
///
///
/// This action is not supported by Amazon S3 on Outposts.
///
///
///
/// This action performs the following types of requests:
///
/// -
///
///
select - Perform a select query on an archived object
///
/// -
///
///
restore an archive - Restore an archived object
///
///
///
/// For more information about the S3 structure in the request body, see
/// the following:
///
///
///
/// Define the SQL expression for the SELECT type of restoration for your
/// query in the request body's SelectParameters structure. You can use expressions
/// like the following examples.
///
/// -
///
/// The following expression returns all records from the specified object.
///
///
///
///
SELECT * FROM Object
///
/// -
///
/// Assuming that you are not using any headers for data stored in the object, you can
/// specify columns with positional headers.
///
///
///
///
SELECT s._1, s._2 FROM Object s WHERE s._3 > 100
///
/// -
///
/// If you have headers and you set the
fileHeaderInfo in the CSV
/// structure in the request body to USE, you can specify headers in the
/// query. (If you set the fileHeaderInfo field to IGNORE, the
/// first row is skipped for the query.) You cannot mix ordinal positions with header
/// column names.
///
///
///
/// SELECT s.Id, s.FirstName, s.SSN FROM S3Object s
///
///
///
/// When making a select request, you can also do the following:
///
/// -
///
/// To expedite your queries, specify the
Expedited tier. For more information
/// about tiers, see "Restoring Archives," later in this topic.
///
/// -
///
/// Specify details about the data serialization format of both the input object that
/// is being queried and the serialization of the CSV-encoded query results.
///
///
///
/// The following are additional important facts about the select feature:
///
/// -
///
/// The output results are new Amazon S3 objects. Unlike archive retrievals, they are
/// stored until explicitly deleted-manually or through a lifecycle configuration.
///
///
-
///
/// You can issue more than one select request on the same Amazon S3 object. Amazon S3
/// doesn't duplicate requests, so avoid issuing duplicate requests.
///
///
-
///
/// Amazon S3 accepts a select request even if the object has already been restored.
/// A select request doesn’t return error response
409.
///
///
- Permissions
-
///
/// To use this operation, you must have permissions to perform the
s3:RestoreObject
/// action. The bucket owner has this permission by default and can grant this permission
/// to others. For more information about permissions, see Permissions
/// Related to Bucket Subresource Operations and Managing
/// Access Permissions to Your Amazon S3 Resources in the Amazon S3 User Guide.
///
/// - Restoring objects
-
///
/// Objects that you archive to the S3 Glacier Flexible Retrieval Flexible Retrieval or
/// S3 Glacier Deep Archive storage class, and S3 Intelligent-Tiering Archive or S3 Intelligent-Tiering
/// Deep Archive tiers, are not accessible in real time. For objects in the S3 Glacier
/// Flexible Retrieval Flexible Retrieval or S3 Glacier Deep Archive storage classes,
/// you must first initiate a restore request, and then wait until a temporary copy of
/// the object is available. If you want a permanent copy of the object, create a copy
/// of it in the Amazon S3 Standard storage class in your S3 bucket. To access an archived
/// object, you must restore the object for the duration (number of days) that you specify.
/// For objects in the Archive Access or Deep Archive Access tiers of S3 Intelligent-Tiering,
/// you must first initiate a restore request, and then wait until the object is moved
/// into the Frequent Access tier.
///
///
///
/// To restore a specific object version, you can provide a version ID. If you don't provide
/// a version ID, Amazon S3 restores the current version.
///
///
///
/// When restoring an archived object, you can specify one of the following data access
/// tier options in the
Tier element of the request body:
///
/// -
///
///
Expedited - Expedited retrievals allow you to quickly access your data
/// stored in the S3 Glacier Flexible Retrieval Flexible Retrieval storage class or S3
/// Intelligent-Tiering Archive tier when occasional urgent requests for restoring archives
/// are required. For all but the largest archived objects (250 MB+), data accessed using
/// Expedited retrievals is typically made available within 1–5 minutes. Provisioned capacity
/// ensures that retrieval capacity for Expedited retrievals is available when you need
/// it. Expedited retrievals and provisioned capacity are not available for objects stored
/// in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive
/// tier.
///
/// -
///
///
Standard - Standard retrievals allow you to access any of your archived
/// objects within several hours. This is the default option for retrieval requests that
/// do not specify the retrieval option. Standard retrievals typically finish within 3–5
/// hours for objects stored in the S3 Glacier Flexible Retrieval Flexible Retrieval storage
/// class or S3 Intelligent-Tiering Archive tier. They typically finish within 12 hours
/// for objects stored in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering
/// Deep Archive tier. Standard retrievals are free for objects stored in S3 Intelligent-Tiering.
///
/// -
///
///
Bulk - Bulk retrievals free for objects stored in the S3 Glacier Flexible
/// Retrieval and S3 Intelligent-Tiering storage classes, enabling you to retrieve large
/// amounts, even petabytes, of data at no cost. Bulk retrievals typically finish within
/// 5–12 hours for objects stored in the S3 Glacier Flexible Retrieval Flexible Retrieval
/// storage class or S3 Intelligent-Tiering Archive tier. Bulk retrievals are also the
/// lowest-cost retrieval option when restoring objects from S3 Glacier Deep Archive.
/// They typically finish within 48 hours for objects stored in the S3 Glacier Deep Archive
/// storage class or S3 Intelligent-Tiering Deep Archive tier.
///
///
///
/// For more information about archive retrieval options and provisioned capacity for
/// Expedited data access, see Restoring
/// Archived Objects in the Amazon S3 User Guide.
///
///
///
/// You can use Amazon S3 restore speed upgrade to change the restore speed to a faster
/// speed while it is in progress. For more information, see
/// Upgrading the speed of an in-progress restore in the Amazon S3 User Guide.
///
///
///
///
/// To get the status of object restoration, you can send a HEAD request.
/// Operations return the x-amz-restore header, which provides information
/// about the restoration status, in the response. You can use Amazon S3 event notifications
/// to notify you when a restore is initiated or completed. For more information, see
/// Configuring
/// Amazon S3 Event Notifications in the Amazon S3 User Guide.
///
///
///
/// After restoring an archived object, you can update the restoration period by reissuing
/// the request with a new period. Amazon S3 updates the restoration period relative to
/// the current time and charges only for the request-there are no data transfer charges.
/// You cannot update the restoration period when Amazon S3 is actively processing your
/// current restore request for the object.
///
///
///
/// If your bucket has a lifecycle configuration with a rule that includes an expiration
/// action, the object expiration overrides the life span that you specify in a restore
/// request. For example, if you restore an object copy for 10 days, but the object is
/// scheduled to expire in 3 days, Amazon S3 deletes the object in 3 days. For more information
/// about lifecycle configuration, see PutBucketLifecycleConfiguration
/// and Object
/// Lifecycle Management in Amazon S3 User Guide.
///
/// - Responses
-
///
/// A successful action returns either the
200 OK or 202 Accepted
/// status code.
///
/// -
///
/// If the object is not previously restored, then Amazon S3 returns
202 Accepted
/// in the response.
///
/// -
///
/// If the object is previously restored, Amazon S3 returns
200 OK in the
/// response.
///
///
-
///
/// Special errors:
///
///
-
///
/// Code: RestoreAlreadyInProgress
///
///
-
///
/// Cause: Object restore is already in progress. (This error does not apply to SELECT
/// type requests.)
///
///
-
///
/// HTTP Status Code: 409 Conflict
///
///
-
///
/// SOAP Fault Code Prefix: Client
///
///
-
-
///
/// Code: GlacierExpeditedRetrievalNotAvailable
///
///
-
///
/// Cause: expedited retrievals are currently not available. Try again later. (Returned
/// if there is insufficient capacity to process the Expedited request. This error applies
/// only to Expedited retrievals and not to S3 Standard or Bulk retrievals.)
///
///
-
///
/// HTTP Status Code: 503
///
///
-
///
/// SOAP Fault Code Prefix: N/A
///
///
///
/// The following operations are related to RestoreObject:
///
///
///
/// The bucket name containing the object to restore. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form 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 action was initiated.
/// VersionId used to reference a specific version of the object.
///
/// The response from the RestoreObject service method, as returned by S3.
/// REST API Reference for RestoreObject Operation
public virtual RestoreObjectResponse RestoreObject(string bucketName, string key, string versionId)
{
var request = new RestoreObjectRequest();
request.BucketName = bucketName;
request.Key = key;
request.VersionId = versionId;
return RestoreObject(request);
}
///
/// Restores an archived copy of an object back into Amazon S3
///
///
///
/// This action is not supported by Amazon S3 on Outposts.
///
///
///
/// This action performs the following types of requests:
///
/// -
///
///
select - Perform a select query on an archived object
///
/// -
///
///
restore an archive - Restore an archived object
///
///
///
/// For more information about the S3 structure in the request body, see
/// the following:
///
///
///
/// Define the SQL expression for the SELECT type of restoration for your
/// query in the request body's SelectParameters structure. You can use expressions
/// like the following examples.
///
/// -
///
/// The following expression returns all records from the specified object.
///
///
///
///
SELECT * FROM Object
///
/// -
///
/// Assuming that you are not using any headers for data stored in the object, you can
/// specify columns with positional headers.
///
///
///
///
SELECT s._1, s._2 FROM Object s WHERE s._3 > 100
///
/// -
///
/// If you have headers and you set the
fileHeaderInfo in the CSV
/// structure in the request body to USE, you can specify headers in the
/// query. (If you set the fileHeaderInfo field to IGNORE, the
/// first row is skipped for the query.) You cannot mix ordinal positions with header
/// column names.
///
///
///
/// SELECT s.Id, s.FirstName, s.SSN FROM S3Object s
///
///
///
/// When making a select request, you can also do the following:
///
/// -
///
/// To expedite your queries, specify the
Expedited tier. For more information
/// about tiers, see "Restoring Archives," later in this topic.
///
/// -
///
/// Specify details about the data serialization format of both the input object that
/// is being queried and the serialization of the CSV-encoded query results.
///
///
///
/// The following are additional important facts about the select feature:
///
/// -
///
/// The output results are new Amazon S3 objects. Unlike archive retrievals, they are
/// stored until explicitly deleted-manually or through a lifecycle configuration.
///
///
-
///
/// You can issue more than one select request on the same Amazon S3 object. Amazon S3
/// doesn't duplicate requests, so avoid issuing duplicate requests.
///
///
-
///
/// Amazon S3 accepts a select request even if the object has already been restored.
/// A select request doesn’t return error response
409.
///
///
- Permissions
-
///
/// To use this operation, you must have permissions to perform the
s3:RestoreObject
/// action. The bucket owner has this permission by default and can grant this permission
/// to others. For more information about permissions, see Permissions
/// Related to Bucket Subresource Operations and Managing
/// Access Permissions to Your Amazon S3 Resources in the Amazon S3 User Guide.
///
/// - Restoring objects
-
///
/// Objects that you archive to the S3 Glacier Flexible Retrieval Flexible Retrieval or
/// S3 Glacier Deep Archive storage class, and S3 Intelligent-Tiering Archive or S3 Intelligent-Tiering
/// Deep Archive tiers, are not accessible in real time. For objects in the S3 Glacier
/// Flexible Retrieval Flexible Retrieval or S3 Glacier Deep Archive storage classes,
/// you must first initiate a restore request, and then wait until a temporary copy of
/// the object is available. If you want a permanent copy of the object, create a copy
/// of it in the Amazon S3 Standard storage class in your S3 bucket. To access an archived
/// object, you must restore the object for the duration (number of days) that you specify.
/// For objects in the Archive Access or Deep Archive Access tiers of S3 Intelligent-Tiering,
/// you must first initiate a restore request, and then wait until the object is moved
/// into the Frequent Access tier.
///
///
///
/// To restore a specific object version, you can provide a version ID. If you don't provide
/// a version ID, Amazon S3 restores the current version.
///
///
///
/// When restoring an archived object, you can specify one of the following data access
/// tier options in the
Tier element of the request body:
///
/// -
///
///
Expedited - Expedited retrievals allow you to quickly access your data
/// stored in the S3 Glacier Flexible Retrieval Flexible Retrieval storage class or S3
/// Intelligent-Tiering Archive tier when occasional urgent requests for restoring archives
/// are required. For all but the largest archived objects (250 MB+), data accessed using
/// Expedited retrievals is typically made available within 1–5 minutes. Provisioned capacity
/// ensures that retrieval capacity for Expedited retrievals is available when you need
/// it. Expedited retrievals and provisioned capacity are not available for objects stored
/// in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive
/// tier.
///
/// -
///
///
Standard - Standard retrievals allow you to access any of your archived
/// objects within several hours. This is the default option for retrieval requests that
/// do not specify the retrieval option. Standard retrievals typically finish within 3–5
/// hours for objects stored in the S3 Glacier Flexible Retrieval Flexible Retrieval storage
/// class or S3 Intelligent-Tiering Archive tier. They typically finish within 12 hours
/// for objects stored in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering
/// Deep Archive tier. Standard retrievals are free for objects stored in S3 Intelligent-Tiering.
///
/// -
///
///
Bulk - Bulk retrievals free for objects stored in the S3 Glacier Flexible
/// Retrieval and S3 Intelligent-Tiering storage classes, enabling you to retrieve large
/// amounts, even petabytes, of data at no cost. Bulk retrievals typically finish within
/// 5–12 hours for objects stored in the S3 Glacier Flexible Retrieval Flexible Retrieval
/// storage class or S3 Intelligent-Tiering Archive tier. Bulk retrievals are also the
/// lowest-cost retrieval option when restoring objects from S3 Glacier Deep Archive.
/// They typically finish within 48 hours for objects stored in the S3 Glacier Deep Archive
/// storage class or S3 Intelligent-Tiering Deep Archive tier.
///
///
///
/// For more information about archive retrieval options and provisioned capacity for
/// Expedited data access, see Restoring
/// Archived Objects in the Amazon S3 User Guide.
///
///
///
/// You can use Amazon S3 restore speed upgrade to change the restore speed to a faster
/// speed while it is in progress. For more information, see
/// Upgrading the speed of an in-progress restore in the Amazon S3 User Guide.
///
///
///
///
/// To get the status of object restoration, you can send a HEAD request.
/// Operations return the x-amz-restore header, which provides information
/// about the restoration status, in the response. You can use Amazon S3 event notifications
/// to notify you when a restore is initiated or completed. For more information, see
/// Configuring
/// Amazon S3 Event Notifications in the Amazon S3 User Guide.
///
///
///
/// After restoring an archived object, you can update the restoration period by reissuing
/// the request with a new period. Amazon S3 updates the restoration period relative to
/// the current time and charges only for the request-there are no data transfer charges.
/// You cannot update the restoration period when Amazon S3 is actively processing your
/// current restore request for the object.
///
///
///
/// If your bucket has a lifecycle configuration with a rule that includes an expiration
/// action, the object expiration overrides the life span that you specify in a restore
/// request. For example, if you restore an object copy for 10 days, but the object is
/// scheduled to expire in 3 days, Amazon S3 deletes the object in 3 days. For more information
/// about lifecycle configuration, see PutBucketLifecycleConfiguration
/// and Object
/// Lifecycle Management in Amazon S3 User Guide.
///
/// - Responses
-
///
/// A successful action returns either the
200 OK or 202 Accepted
/// status code.
///
/// -
///
/// If the object is not previously restored, then Amazon S3 returns
202 Accepted
/// in the response.
///
/// -
///
/// If the object is previously restored, Amazon S3 returns
200 OK in the
/// response.
///
///
-
///
/// Special errors:
///
///
-
///
/// Code: RestoreAlreadyInProgress
///
///
-
///
/// Cause: Object restore is already in progress. (This error does not apply to SELECT
/// type requests.)
///
///
-
///
/// HTTP Status Code: 409 Conflict
///
///
-
///
/// SOAP Fault Code Prefix: Client
///
///
-
-
///
/// Code: GlacierExpeditedRetrievalNotAvailable
///
///
-
///
/// Cause: expedited retrievals are currently not available. Try again later. (Returned
/// if there is insufficient capacity to process the Expedited request. This error applies
/// only to Expedited retrievals and not to S3 Standard or Bulk retrievals.)
///
///
-
///
/// HTTP Status Code: 503
///
///
-
///
/// SOAP Fault Code Prefix: N/A
///
///
///
/// The following operations are related to RestoreObject:
///
///
///
/// The bucket name containing the object to restore. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form 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 action was initiated.
/// VersionId used to reference a specific version of the object.
/// A property of RestoreObjectRequest used to execute the RestoreObject service method.
///
/// The response from the RestoreObject service method, as returned by S3.
/// REST API Reference for RestoreObject Operation
public virtual RestoreObjectResponse RestoreObject(string bucketName, string key, string versionId, int days)
{
var request = new RestoreObjectRequest();
request.BucketName = bucketName;
request.Key = key;
request.VersionId = versionId;
request.Days = days;
return RestoreObject(request);
}
///
/// Restores an archived copy of an object back into Amazon S3
///
///
///
/// This action is not supported by Amazon S3 on Outposts.
///
///
///
/// This action performs the following types of requests:
///
/// -
///
///
select - Perform a select query on an archived object
///
/// -
///
///
restore an archive - Restore an archived object
///
///
///
/// For more information about the S3 structure in the request body, see
/// the following:
///
///
///
/// Define the SQL expression for the SELECT type of restoration for your
/// query in the request body's SelectParameters structure. You can use expressions
/// like the following examples.
///
/// -
///
/// The following expression returns all records from the specified object.
///
///
///
///
SELECT * FROM Object
///
/// -
///
/// Assuming that you are not using any headers for data stored in the object, you can
/// specify columns with positional headers.
///
///
///
///
SELECT s._1, s._2 FROM Object s WHERE s._3 > 100
///
/// -
///
/// If you have headers and you set the
fileHeaderInfo in the CSV
/// structure in the request body to USE, you can specify headers in the
/// query. (If you set the fileHeaderInfo field to IGNORE, the
/// first row is skipped for the query.) You cannot mix ordinal positions with header
/// column names.
///
///
///
/// SELECT s.Id, s.FirstName, s.SSN FROM S3Object s
///
///
///
/// When making a select request, you can also do the following:
///
/// -
///
/// To expedite your queries, specify the
Expedited tier. For more information
/// about tiers, see "Restoring Archives," later in this topic.
///
/// -
///
/// Specify details about the data serialization format of both the input object that
/// is being queried and the serialization of the CSV-encoded query results.
///
///
///
/// The following are additional important facts about the select feature:
///
/// -
///
/// The output results are new Amazon S3 objects. Unlike archive retrievals, they are
/// stored until explicitly deleted-manually or through a lifecycle configuration.
///
///
-
///
/// You can issue more than one select request on the same Amazon S3 object. Amazon S3
/// doesn't duplicate requests, so avoid issuing duplicate requests.
///
///
-
///
/// Amazon S3 accepts a select request even if the object has already been restored.
/// A select request doesn’t return error response
409.
///
///
- Permissions
-
///
/// To use this operation, you must have permissions to perform the
s3:RestoreObject
/// action. The bucket owner has this permission by default and can grant this permission
/// to others. For more information about permissions, see Permissions
/// Related to Bucket Subresource Operations and Managing
/// Access Permissions to Your Amazon S3 Resources in the Amazon S3 User Guide.
///
/// - Restoring objects
-
///
/// Objects that you archive to the S3 Glacier Flexible Retrieval Flexible Retrieval or
/// S3 Glacier Deep Archive storage class, and S3 Intelligent-Tiering Archive or S3 Intelligent-Tiering
/// Deep Archive tiers, are not accessible in real time. For objects in the S3 Glacier
/// Flexible Retrieval Flexible Retrieval or S3 Glacier Deep Archive storage classes,
/// you must first initiate a restore request, and then wait until a temporary copy of
/// the object is available. If you want a permanent copy of the object, create a copy
/// of it in the Amazon S3 Standard storage class in your S3 bucket. To access an archived
/// object, you must restore the object for the duration (number of days) that you specify.
/// For objects in the Archive Access or Deep Archive Access tiers of S3 Intelligent-Tiering,
/// you must first initiate a restore request, and then wait until the object is moved
/// into the Frequent Access tier.
///
///
///
/// To restore a specific object version, you can provide a version ID. If you don't provide
/// a version ID, Amazon S3 restores the current version.
///
///
///
/// When restoring an archived object, you can specify one of the following data access
/// tier options in the
Tier element of the request body:
///
/// -
///
///
Expedited - Expedited retrievals allow you to quickly access your data
/// stored in the S3 Glacier Flexible Retrieval Flexible Retrieval storage class or S3
/// Intelligent-Tiering Archive tier when occasional urgent requests for restoring archives
/// are required. For all but the largest archived objects (250 MB+), data accessed using
/// Expedited retrievals is typically made available within 1–5 minutes. Provisioned capacity
/// ensures that retrieval capacity for Expedited retrievals is available when you need
/// it. Expedited retrievals and provisioned capacity are not available for objects stored
/// in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive
/// tier.
///
/// -
///
///
Standard - Standard retrievals allow you to access any of your archived
/// objects within several hours. This is the default option for retrieval requests that
/// do not specify the retrieval option. Standard retrievals typically finish within 3–5
/// hours for objects stored in the S3 Glacier Flexible Retrieval Flexible Retrieval storage
/// class or S3 Intelligent-Tiering Archive tier. They typically finish within 12 hours
/// for objects stored in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering
/// Deep Archive tier. Standard retrievals are free for objects stored in S3 Intelligent-Tiering.
///
/// -
///
///
Bulk - Bulk retrievals free for objects stored in the S3 Glacier Flexible
/// Retrieval and S3 Intelligent-Tiering storage classes, enabling you to retrieve large
/// amounts, even petabytes, of data at no cost. Bulk retrievals typically finish within
/// 5–12 hours for objects stored in the S3 Glacier Flexible Retrieval Flexible Retrieval
/// storage class or S3 Intelligent-Tiering Archive tier. Bulk retrievals are also the
/// lowest-cost retrieval option when restoring objects from S3 Glacier Deep Archive.
/// They typically finish within 48 hours for objects stored in the S3 Glacier Deep Archive
/// storage class or S3 Intelligent-Tiering Deep Archive tier.
///
///
///
/// For more information about archive retrieval options and provisioned capacity for
/// Expedited data access, see Restoring
/// Archived Objects in the Amazon S3 User Guide.
///
///
///
/// You can use Amazon S3 restore speed upgrade to change the restore speed to a faster
/// speed while it is in progress. For more information, see
/// Upgrading the speed of an in-progress restore in the Amazon S3 User Guide.
///
///
///
///
/// To get the status of object restoration, you can send a HEAD request.
/// Operations return the x-amz-restore header, which provides information
/// about the restoration status, in the response. You can use Amazon S3 event notifications
/// to notify you when a restore is initiated or completed. For more information, see
/// Configuring
/// Amazon S3 Event Notifications in the Amazon S3 User Guide.
///
///
///
/// After restoring an archived object, you can update the restoration period by reissuing
/// the request with a new period. Amazon S3 updates the restoration period relative to
/// the current time and charges only for the request-there are no data transfer charges.
/// You cannot update the restoration period when Amazon S3 is actively processing your
/// current restore request for the object.
///
///
///
/// If your bucket has a lifecycle configuration with a rule that includes an expiration
/// action, the object expiration overrides the life span that you specify in a restore
/// request. For example, if you restore an object copy for 10 days, but the object is
/// scheduled to expire in 3 days, Amazon S3 deletes the object in 3 days. For more information
/// about lifecycle configuration, see PutBucketLifecycleConfiguration
/// and Object
/// Lifecycle Management in Amazon S3 User Guide.
///
/// - Responses
-
///
/// A successful action returns either the
200 OK or 202 Accepted
/// status code.
///
/// -
///
/// If the object is not previously restored, then Amazon S3 returns
202 Accepted
/// in the response.
///
/// -
///
/// If the object is previously restored, Amazon S3 returns
200 OK in the
/// response.
///
///
-
///
/// Special errors:
///
///
-
///
/// Code: RestoreAlreadyInProgress
///
///
-
///
/// Cause: Object restore is already in progress. (This error does not apply to SELECT
/// type requests.)
///
///
-
///
/// HTTP Status Code: 409 Conflict
///
///
-
///
/// SOAP Fault Code Prefix: Client
///
///
-
-
///
/// Code: GlacierExpeditedRetrievalNotAvailable
///
///
-
///
/// Cause: expedited retrievals are currently not available. Try again later. (Returned
/// if there is insufficient capacity to process the Expedited request. This error applies
/// only to Expedited retrievals and not to S3 Standard or Bulk retrievals.)
///
///
-
///
/// HTTP Status Code: 503
///
///
-
///
/// SOAP Fault Code Prefix: N/A
///
///
///
/// The following operations are related to RestoreObject:
///
///
///
/// Container for the necessary parameters to execute the RestoreObject service method.
///
/// The response from the RestoreObject service method, as returned by S3.
/// REST API Reference for RestoreObject Operation
public virtual RestoreObjectResponse RestoreObject(RestoreObjectRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = RestoreObjectRequestMarshaller.Instance;
options.ResponseUnmarshaller = RestoreObjectResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the RestoreObject operation.
///
///
/// Container for the necessary parameters to execute the RestoreObject operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRestoreObject
/// operation.
/// REST API Reference for RestoreObject Operation
public virtual IAsyncResult BeginRestoreObject(RestoreObjectRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = RestoreObjectRequestMarshaller.Instance;
options.ResponseUnmarshaller = RestoreObjectResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the RestoreObject operation.
///
///
/// The IAsyncResult returned by the call to BeginRestoreObject.
///
/// Returns a RestoreObjectResult from S3.
/// REST API Reference for RestoreObject Operation
public virtual RestoreObjectResponse EndRestoreObject(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#endregion
#region SelectObjectContent
///
/// This action filters the contents of an Amazon S3 object based on a simple structured
/// query language (SQL) statement. In the request, along with the SQL expression, you
/// must also specify a data serialization format (JSON, CSV, or Apache Parquet) of the
/// object. Amazon S3 uses this format to parse object data into records, and returns
/// only records that match the specified SQL expression. You must also specify the data
/// serialization format for the response.
///
///
///
/// This action is not supported by Amazon S3 on Outposts.
///
///
///
/// For more information about Amazon S3 Select, see Selecting
/// Content from Objects and SELECT
/// Command in the Amazon S3 User Guide.
///
/// - Permissions
-
///
/// You must have
s3:GetObject permission for this operation. Amazon S3 Select
/// does not support anonymous access. For more information about permissions, see Specifying
/// Permissions in a Policy in the Amazon S3 User Guide.
///
/// - Object Data Formats
-
///
/// You can use Amazon S3 Select to query objects that have the following format properties:
///
///
-
///
/// CSV, JSON, and Parquet - Objects must be in CSV, JSON, or Parquet format.
///
///
-
///
/// UTF-8 - UTF-8 is the only encoding type Amazon S3 Select supports.
///
///
-
///
/// GZIP or BZIP2 - CSV and JSON files can be compressed using GZIP or BZIP2.
/// GZIP and BZIP2 are the only compression formats that Amazon S3 Select supports for
/// CSV and JSON files. Amazon S3 Select supports columnar compression for Parquet using
/// GZIP or Snappy. Amazon S3 Select does not support whole-object compression for Parquet
/// objects.
///
///
-
///
/// Server-side encryption - Amazon S3 Select supports querying objects that are
/// protected with server-side encryption.
///
///
///
/// For objects that are encrypted with customer-provided encryption keys (SSE-C), you
/// must use HTTPS, and you must use the headers that are documented in the GetObject.
/// For more information about SSE-C, see Server-Side
/// Encryption (Using Customer-Provided Encryption Keys) in the Amazon S3 User
/// Guide.
///
///
///
/// For objects that are encrypted with Amazon S3 managed keys (SSE-S3) and Amazon Web
/// Services KMS keys (SSE-KMS), server-side encryption is handled transparently, so you
/// don't need to specify anything. For more information about server-side encryption,
/// including SSE-S3 and SSE-KMS, see Protecting
/// Data Using Server-Side Encryption in the Amazon S3 User Guide.
///
///
- Working with the Response Body
-
///
/// Given the response size is unknown, Amazon S3 Select streams the response as a series
/// of messages and includes a
Transfer-Encoding header with chunked
/// as its value in the response. For more information, see Appendix:
/// SelectObjectContent Response.
///
/// - GetObject Support
-
///
/// The
SelectObjectContent action does not support the following GetObject
/// functionality. For more information, see GetObject.
///
/// -
///
///
Range: Although you can specify a scan range for an Amazon S3 Select
/// request (see SelectObjectContentRequest
/// - ScanRange in the request parameters), you cannot specify the range of bytes
/// of an object to return.
///
/// -
///
/// The
GLACIER, DEEP_ARCHIVE, and REDUCED_REDUNDANCY
/// storage classes, or the ARCHIVE_ACCESS and DEEP_ARCHIVE_ACCESS
/// access tiers of the INTELLIGENT_TIERING storage class: You cannot query
/// objects in the GLACIER, DEEP_ARCHIVE, or REDUCED_REDUNDANCY
/// storage classes, nor objects in the ARCHIVE_ACCESS or DEEP_ARCHIVE_ACCESS
/// access tiers of the INTELLIGENT_TIERING storage class. For more information
/// about storage classes, see Using
/// Amazon S3 storage classes in the Amazon S3 User Guide.
///
///
- Special Errors
-
///
/// For a list of special errors for this operation, see List
/// of SELECT Object Content Error Codes
///
///
///
/// The following operations are related to SelectObjectContent:
///
///
///
/// Container for the necessary parameters to execute the SelectObjectContent service method.
///
/// The response from the SelectObjectContent service method, as returned by S3.
/// REST API Reference for SelectObjectContent Operation
public virtual SelectObjectContentResponse SelectObjectContent(SelectObjectContentRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = SelectObjectContentRequestMarshaller.Instance;
options.ResponseUnmarshaller = SelectObjectContentResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the SelectObjectContent operation.
///
///
/// Container for the necessary parameters to execute the SelectObjectContent operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSelectObjectContent
/// operation.
/// REST API Reference for SelectObjectContent Operation
public virtual IAsyncResult BeginSelectObjectContent(SelectObjectContentRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = SelectObjectContentRequestMarshaller.Instance;
options.ResponseUnmarshaller = SelectObjectContentResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the SelectObjectContent operation.
///
///
/// The IAsyncResult returned by the call to BeginSelectObjectContent.
///
/// Returns a SelectObjectContentResult from S3.
/// REST API Reference for SelectObjectContent Operation
public virtual SelectObjectContentResponse EndSelectObjectContent(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#endregion
#region UploadPart
///
/// Uploads a part in a multipart upload.
///
///
///
/// In this operation, you provide part data in your request. However, you have an option
/// to specify your existing Amazon S3 object as a data source for the part you are uploading.
/// To upload a part from an existing object, you use the UploadPartCopy
/// operation.
///
///
///
/// You must initiate a multipart upload (see CreateMultipartUpload)
/// before you can upload any part. In response to your initiate request, Amazon S3 returns
/// an upload ID, a unique identifier, that you must include in your upload part request.
///
///
///
/// Part numbers can be any number from 1 to 10,000, inclusive. A part number uniquely
/// identifies a part and also defines its position within the object being created. If
/// you upload a new part using the same part number that was used with a previous part,
/// the previously uploaded part is overwritten.
///
///
///
/// For information about maximum and minimum part sizes and other multipart upload specifications,
/// see Multipart
/// upload limits in the Amazon S3 User Guide.
///
///
///
/// To ensure that data is not corrupted when traversing the network, specify the Content-MD5
/// header in the upload part request. Amazon S3 checks the part data against the provided
/// MD5 value. If they do not match, Amazon S3 returns an error.
///
///
///
/// If the upload request is signed with Signature Version 4, then Amazon Web Services
/// S3 uses the x-amz-content-sha256 header as a checksum instead of Content-MD5.
/// For more information see Authenticating
/// Requests: Using the Authorization Header (Amazon Web Services Signature Version 4).
///
///
///
///
/// Note: After you initiate multipart upload and upload one or more parts, you
/// must either complete or abort multipart upload in order to stop getting charged for
/// storage of the uploaded parts. Only after you either complete or abort multipart upload,
/// Amazon S3 frees up the parts storage and stops charging you for the parts storage.
///
///
///
/// For more information on multipart uploads, go to Multipart
/// Upload Overview in the Amazon S3 User Guide .
///
///
///
/// For information on the permissions required to use the multipart upload API, go to
/// Multipart
/// Upload and Permissions in the Amazon S3 User Guide.
///
///
///
/// Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data
/// as it writes it to disks in its data centers and decrypts it when you access it. You
/// have three mutually exclusive options to protect data using server-side encryption
/// in Amazon S3, depending on how you choose to manage the encryption keys. Specifically,
/// the encryption key options are Amazon S3 managed keys (SSE-S3), Amazon Web Services
/// KMS keys (SSE-KMS), and Customer-Provided Keys (SSE-C). Amazon S3 encrypts data with
/// server-side encryption using Amazon S3 managed keys (SSE-S3) by default. You can optionally
/// tell Amazon S3 to encrypt data at rest using server-side encryption with other key
/// options. The option you use depends on whether you want to use KMS keys (SSE-KMS)
/// or provide your own encryption key (SSE-C). If you choose to provide your own encryption
/// key, the request headers you provide in the request must match the headers you used
/// in the request to initiate the upload by using CreateMultipartUpload.
/// For more information, go to Using
/// Server-Side Encryption in the Amazon S3 User Guide.
///
///
///
/// Server-side encryption is supported by the S3 Multipart Upload actions. Unless you
/// are using a customer-provided encryption key (SSE-C), you don't need to specify the
/// encryption parameters in each UploadPart request. Instead, you only need to specify
/// the server-side encryption parameters in the initial Initiate Multipart request. For
/// more information, see CreateMultipartUpload.
///
///
///
/// If you requested server-side encryption using a customer-provided encryption key (SSE-C)
/// in your initiate multipart upload request, you must provide identical encryption information
/// in each part upload using the following headers.
///
/// -
///
/// x-amz-server-side-encryption-customer-algorithm
///
///
-
///
/// x-amz-server-side-encryption-customer-key
///
///
-
///
/// x-amz-server-side-encryption-customer-key-MD5
///
///
///
/// UploadPart has the following special errors:
///
/// -
-
///
/// Code: NoSuchUpload
///
///
-
///
/// Cause: The specified multipart upload does not exist. The upload ID might be invalid,
/// or the multipart upload might have been aborted or completed.
///
///
-
///
/// HTTP Status Code: 404 Not Found
///
///
-
///
/// SOAP Fault Code Prefix: Client
///
///
///
/// The following operations are related to UploadPart:
///
///
///
/// Container for the necessary parameters to execute the UploadPart service method.
///
/// The response from the UploadPart service method, as returned by S3.
/// REST API Reference for UploadPart Operation
public virtual UploadPartResponse UploadPart(UploadPartRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = UploadPartRequestMarshaller.Instance;
options.ResponseUnmarshaller = UploadPartResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the UploadPart operation.
///
///
/// Container for the necessary parameters to execute the UploadPart operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUploadPart
/// operation.
/// REST API Reference for UploadPart Operation
public virtual IAsyncResult BeginUploadPart(UploadPartRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = UploadPartRequestMarshaller.Instance;
options.ResponseUnmarshaller = UploadPartResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the UploadPart operation.
///
///
/// The IAsyncResult returned by the call to BeginUploadPart.
///
/// Returns a UploadPartResult from S3.
/// REST API Reference for UploadPart Operation
public virtual UploadPartResponse EndUploadPart(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#endregion
#region WriteGetObjectResponse
///
/// Passes transformed objects to a GetObject operation when using Object
/// Lambda access points. For information about Object Lambda access points, see Transforming
/// objects with Object Lambda access points in the Amazon S3 User Guide.
///
///
///
/// This operation supports metadata that can be returned by GetObject,
/// in addition to RequestRoute, RequestToken, StatusCode,
/// ErrorCode, and ErrorMessage. The GetObject
/// response metadata is supported so that the WriteGetObjectResponse caller,
/// typically an Lambda function, can provide the same metadata when it internally invokes
/// GetObject. When WriteGetObjectResponse is called by a customer-owned
/// Lambda function, the metadata returned to the end user GetObject call
/// might differ from what Amazon S3 would normally return.
///
///
///
/// You can include any number of metadata headers. When including a metadata header,
/// it should be prefaced with x-amz-meta. For example, x-amz-meta-my-custom-header:
/// MyCustomValue. The primary use case for this is to forward GetObject
/// metadata.
///
///
///
/// Amazon Web Services provides some prebuilt Lambda functions that you can use with
/// S3 Object Lambda to detect and redact personally identifiable information (PII) and
/// decompress S3 objects. These Lambda functions are available in the Amazon Web Services
/// Serverless Application Repository, and can be selected through the Amazon Web Services
/// Management Console when you create your Object Lambda access point.
///
///
///
/// Example 1: PII Access Control - This Lambda function uses Amazon Comprehend, a natural
/// language processing (NLP) service using machine learning to find insights and relationships
/// in text. It automatically detects personally identifiable information (PII) such as
/// names, addresses, dates, credit card numbers, and social security numbers from documents
/// in your Amazon S3 bucket.
///
///
///
/// Example 2: PII Redaction - This Lambda function uses Amazon Comprehend, a natural
/// language processing (NLP) service using machine learning to find insights and relationships
/// in text. It automatically redacts personally identifiable information (PII) such as
/// names, addresses, dates, credit card numbers, and social security numbers from documents
/// in your Amazon S3 bucket.
///
///
///
/// Example 3: Decompression - The Lambda function S3ObjectLambdaDecompression, is equipped
/// to decompress objects stored in S3 in one of six compressed file formats including
/// bzip2, gzip, snappy, zlib, zstandard and ZIP.
///
///
///
/// For information on how to view and use these functions, see Using
/// Amazon Web Services built Lambda functions in the Amazon S3 User Guide.
///
///
/// Container for the necessary parameters to execute the WriteGetObjectResponse service method.
///
/// The response from the WriteGetObjectResponse service method, as returned by S3.
/// REST API Reference for WriteGetObjectResponse Operation
public virtual WriteGetObjectResponseResponse WriteGetObjectResponse(WriteGetObjectResponseRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = WriteGetObjectResponseRequestMarshaller.Instance;
options.ResponseUnmarshaller = WriteGetObjectResponseResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the WriteGetObjectResponse operation.
///
///
/// Container for the necessary parameters to execute the WriteGetObjectResponse operation on AmazonS3Client.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndWriteGetObjectResponse
/// operation.
/// REST API Reference for WriteGetObjectResponse Operation
public virtual IAsyncResult BeginWriteGetObjectResponse(WriteGetObjectResponseRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = WriteGetObjectResponseRequestMarshaller.Instance;
options.ResponseUnmarshaller = WriteGetObjectResponseResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the WriteGetObjectResponse operation.
///
///
/// The IAsyncResult returned by the call to BeginWriteGetObjectResponse.
///
/// Returns a WriteGetObjectResponseResult from S3.
/// REST API Reference for WriteGetObjectResponse Operation
public virtual WriteGetObjectResponseResponse EndWriteGetObjectResponse(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#endregion
}
}