Twoorb Plugins  1.0
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Amazon.S3.IAmazonS3 Interface Reference

Interface for accessing AmazonS3. More...

Inheritance diagram for Amazon.S3.IAmazonS3:
Amazon.S3.AmazonS3Client Amazon.S3.AmazonS3Client Amazon.S3.Encryption.AmazonS3EncryptionClient Amazon.S3.Encryption.AmazonS3EncryptionClient

Public Member Functions

void PutObject (PutObjectRequest putObjectRequest, Action< PutObjectResponse > responseCallback)
 
PutObjectResponse EndPutObject (IAsyncResult asyncResult)
 Finishes the asynchronous execution of the PutObject operation.

See Also
Amazon.S3.IAmazonS3.PutObject
More...
 
void PutBucket (PutBucketRequest putBucketRequest, Action< PutBucketResponse > responseCallback)
 
PutBucketResponse EndPutBucket (IAsyncResult asyncResult)
 Finishes the asynchronous execution of the PutBucket operation.

See Also
Amazon.S3.IAmazonS3.PutBucket
More...
 
void DeleteObjects (DeleteObjectsRequest deleteObjectsRequest, Action< DeleteObjectsResponse > responseCallback)
 
DeleteObjectsResponse EndDeleteObjects (IAsyncResult asyncResult)
 Finishes the asynchronous execution of the DeleteObjects operation.

See Also
Amazon.S3.IAmazonS3.DeleteObjects
More...
 
void DeleteBucket (DeleteBucketRequest deleteBucketRequest, Action< DeleteBucketResponse > responseCallback)
 
DeleteBucketResponse EndDeleteBucket (IAsyncResult asyncResult)
 Finishes the asynchronous execution of the DeleteBucket operation.

See Also
Amazon.S3.IAmazonS3.DeleteBucket
More...
 
void ListMultipartUploads (ListMultipartUploadsRequest listMultipartUploadsRequest, Action< ListMultipartUploadsResponse > responseCallback)
 
ListMultipartUploadsResponse EndListMultipartUploads (IAsyncResult asyncResult)
 Finishes the asynchronous execution of the ListMultipartUploads operation.

See Also
Amazon.S3.IAmazonS3.ListMultipartUploads
More...
 
void CompleteMultipartUpload (CompleteMultipartUploadRequest completeMultipartUploadRequest, Action< CompleteMultipartUploadResponse > responseCallback)
 
CompleteMultipartUploadResponse EndCompleteMultipartUpload (IAsyncResult asyncResult)
 Finishes the asynchronous execution of the CompleteMultipartUpload operation.

See Also
Amazon.S3.IAmazonS3.CompleteMultipartUpload
More...
 
void GetObject (GetObjectRequest getObjectRequest, Action< GetObjectResponse > responseCallback)
 
GetObjectResponse EndGetObject (IAsyncResult asyncResult)
 Finishes the asynchronous execution of the GetObject operation.

See Also
Amazon.S3.IAmazonS3.GetObject
More...
 
void AbortMultipartUpload (AbortMultipartUploadRequest abortMultipartUploadRequest, Action< AbortMultipartUploadResponse > responseCallback)
 
AbortMultipartUploadResponse EndAbortMultipartUpload (IAsyncResult asyncResult)
 Finishes the asynchronous execution of the AbortMultipartUpload operation.

See Also
Amazon.S3.IAmazonS3.AbortMultipartUpload
More...
 
void UploadPart (UploadPartRequest uploadPartRequest, Action< UploadPartResponse > responseCallback)
 
UploadPartResponse EndUploadPart (IAsyncResult asyncResult)
 Finishes the asynchronous execution of the UploadPart operation.

See Also
Amazon.S3.IAmazonS3.UploadPart
More...
 
void DeleteObject (DeleteObjectRequest deleteObjectRequest, Action< DeleteObjectResponse > responseCallback)
 
DeleteObjectResponse EndDeleteObject (IAsyncResult asyncResult)
 Finishes the asynchronous execution of the DeleteObject operation.

See Also
Amazon.S3.IAmazonS3.DeleteObject
More...
 
void InitiateMultipartUpload (InitiateMultipartUploadRequest initiateMultipartUploadRequest, Action< InitiateMultipartUploadResponse > responseCallback)
 
InitiateMultipartUploadResponse EndInitiateMultipartUpload (IAsyncResult asyncResult)
 Finishes the asynchronous execution of the InitiateMultipartUpload operation.

See Also
Amazon.S3.IAmazonS3.InitiateMultipartUpload
More...
 
void ListObjects (ListObjectsRequest listObjectsRequest, Action< ListObjectsResponse > responseCallback)
 
ListObjectsResponse EndListObjects (IAsyncResult asyncResult)
 Finishes the asynchronous execution of the ListObjects operation.

See Also
Amazon.S3.IAmazonS3.ListObjects
More...
 
void ListBuckets (ListBucketsRequest listBucketsRequest, Action< ListBucketsResponse > responseCallback)
 
ListBucketsResponse EndListBuckets (IAsyncResult asyncResult)
 Finishes the asynchronous execution of the ListBuckets operation.

See Also
Amazon.S3.IAmazonS3.ListBuckets
More...
 
string GetPreSignedURL (GetPreSignedUrlRequest request)
 Create a signed URL allowing access to a resource that would usually require authentication. More...
 

Detailed Description

Interface for accessing AmazonS3.

Interface for Amazon S3 Clients. For more information about Amazon S3, go to

Member Function Documentation

void Amazon.S3.IAmazonS3.AbortMultipartUpload ( AbortMultipartUploadRequest  abortMultipartUploadRequest,
Action< AbortMultipartUploadResponse responseCallback 
)

Aborts a multipart upload.

Parameters
abortMultipartUploadRequestContainer for the necessary parameters to execute the AbortMultipartUpload service method on AmazonS3.
responseCallbackThe response action that's called when the operation is complete. Upon Failure, the response will be returned with a null parameter

Implemented in Amazon.S3.AmazonS3Client.

void Amazon.S3.IAmazonS3.CompleteMultipartUpload ( CompleteMultipartUploadRequest  completeMultipartUploadRequest,
Action< CompleteMultipartUploadResponse responseCallback 
)

Completes a multipart upload by assembling previously uploaded parts.

Parameters
completeMultipartUploadRequestContainer for the necessary parameters to execute the CompleteMultipartUpload service method on AmazonS3.
responseCallbackThe response action that's called when the operation is complete. Upon Failure, the response will be returned with a null parameter
Returns
The response from the CompleteMultipartUpload service method, as returned by AmazonS3.

Implemented in Amazon.S3.AmazonS3Client.

void Amazon.S3.IAmazonS3.DeleteBucket ( DeleteBucketRequest  deleteBucketRequest,
Action< DeleteBucketResponse responseCallback 
)

Deletes the bucket. All objects (including all object versions and Delete Markers) in the bucket must be deleted before the bucket itself can be deleted.

Parameters
deleteBucketRequestContainer for the necessary parameters to execute the DeleteBucket service method on AmazonS3.
responseCallbackThe response action that's called when the operation is complete. Upon Failure, the response will be returned with a null parameter

Implemented in Amazon.S3.AmazonS3Client.

void Amazon.S3.IAmazonS3.DeleteObject ( DeleteObjectRequest  deleteObjectRequest,
Action< DeleteObjectResponse responseCallback 
)

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.

Parameters
deleteObjectRequestContainer for the necessary parameters to execute the DeleteObject service method on AmazonS3.
responseCallbackThe response action that's called when the operation is complete. Upon Failure, the response will be returned with a null parameter
Returns
The response from the DeleteObject service method, as returned by AmazonS3.

Implemented in Amazon.S3.AmazonS3Client.

void Amazon.S3.IAmazonS3.DeleteObjects ( DeleteObjectsRequest  deleteObjectsRequest,
Action< DeleteObjectsResponse responseCallback 
)

This operation enables you to delete multiple objects from a bucket using a single HTTP request. You may specify up to 1000 keys.

Parameters
deleteObjectsRequestContainer for the necessary parameters to execute the DeleteObjects service method on AmazonS3.
responseCallbackThe response action that's called when the operation is complete. Upon Failure, the response will be returned with a null parameter

Implemented in Amazon.S3.AmazonS3Client.

AbortMultipartUploadResponse Amazon.S3.IAmazonS3.EndAbortMultipartUpload ( IAsyncResult  asyncResult)

Finishes the asynchronous execution of the AbortMultipartUpload operation.

See Also
Amazon.S3.IAmazonS3.AbortMultipartUpload

Parameters
asyncResultThe IAsyncResult returned by the call to BeginAbortMultipartUpload.

Implemented in Amazon.S3.AmazonS3Client.

CompleteMultipartUploadResponse Amazon.S3.IAmazonS3.EndCompleteMultipartUpload ( IAsyncResult  asyncResult)

Finishes the asynchronous execution of the CompleteMultipartUpload operation.

See Also
Amazon.S3.IAmazonS3.CompleteMultipartUpload

Parameters
asyncResultThe IAsyncResult returned by the call to BeginCompleteMultipartUpload.
Returns
Returns a CompleteMultipartUploadResult from AmazonS3.

Implemented in Amazon.S3.AmazonS3Client.

DeleteBucketResponse Amazon.S3.IAmazonS3.EndDeleteBucket ( IAsyncResult  asyncResult)

Finishes the asynchronous execution of the DeleteBucket operation.

See Also
Amazon.S3.IAmazonS3.DeleteBucket

Parameters
asyncResultThe IAsyncResult returned by the call to BeginDeleteBucket.

Implemented in Amazon.S3.AmazonS3Client.

DeleteObjectResponse Amazon.S3.IAmazonS3.EndDeleteObject ( IAsyncResult  asyncResult)

Finishes the asynchronous execution of the DeleteObject operation.

See Also
Amazon.S3.IAmazonS3.DeleteObject

Parameters
asyncResultThe IAsyncResult returned by the call to BeginDeleteObject.
Returns
Returns a DeleteObjectResult from AmazonS3.

Implemented in Amazon.S3.AmazonS3Client.

DeleteObjectsResponse Amazon.S3.IAmazonS3.EndDeleteObjects ( IAsyncResult  asyncResult)

Finishes the asynchronous execution of the DeleteObjects operation.

See Also
Amazon.S3.IAmazonS3.DeleteObjects

Parameters
asyncResultThe IAsyncResult returned by the call to BeginDeleteObjects.
Returns
Returns a DeleteObjectsResult from AmazonS3.

Implemented in Amazon.S3.AmazonS3Client.

GetObjectResponse Amazon.S3.IAmazonS3.EndGetObject ( IAsyncResult  asyncResult)

Finishes the asynchronous execution of the GetObject operation.

See Also
Amazon.S3.IAmazonS3.GetObject

Parameters
asyncResultThe IAsyncResult returned by the call to BeginGetObject.
Returns
Returns a GetObjectResult from AmazonS3.

Implemented in Amazon.S3.AmazonS3Client.

InitiateMultipartUploadResponse Amazon.S3.IAmazonS3.EndInitiateMultipartUpload ( IAsyncResult  asyncResult)

Finishes the asynchronous execution of the InitiateMultipartUpload operation.

See Also
Amazon.S3.IAmazonS3.InitiateMultipartUpload

Parameters
asyncResultThe IAsyncResult returned by the call to BeginInitiateMultipartUpload.
Returns
Returns a InitiateMultipartUploadResult from AmazonS3.

Implemented in Amazon.S3.AmazonS3Client.

ListBucketsResponse Amazon.S3.IAmazonS3.EndListBuckets ( IAsyncResult  asyncResult)

Finishes the asynchronous execution of the ListBuckets operation.

See Also
Amazon.S3.IAmazonS3.ListBuckets

Parameters
asyncResultThe IAsyncResult returned by the call to BeginListBuckets.
Returns
Returns a ListBucketsResult from AmazonS3.

Implemented in Amazon.S3.AmazonS3Client.

ListMultipartUploadsResponse Amazon.S3.IAmazonS3.EndListMultipartUploads ( IAsyncResult  asyncResult)

Finishes the asynchronous execution of the ListMultipartUploads operation.

See Also
Amazon.S3.IAmazonS3.ListMultipartUploads

Parameters
asyncResultThe IAsyncResult returned by the call to BeginListMultipartUploads.
Returns
Returns a ListMultipartUploadsResult from AmazonS3.

Implemented in Amazon.S3.AmazonS3Client.

ListObjectsResponse Amazon.S3.IAmazonS3.EndListObjects ( IAsyncResult  asyncResult)

Finishes the asynchronous execution of the ListObjects operation.

See Also
Amazon.S3.IAmazonS3.ListObjects

Parameters
asyncResultThe IAsyncResult returned by the call to BeginListObjects.
Returns
Returns a ListObjectsResult from AmazonS3.

Implemented in Amazon.S3.AmazonS3Client.

PutBucketResponse Amazon.S3.IAmazonS3.EndPutBucket ( IAsyncResult  asyncResult)

Finishes the asynchronous execution of the PutBucket operation.

See Also
Amazon.S3.IAmazonS3.PutBucket

Parameters
asyncResultThe IAsyncResult returned by the call to BeginPutBucket.
Returns
Returns a PutBucketResult from AmazonS3.

Implemented in Amazon.S3.AmazonS3Client.

PutObjectResponse Amazon.S3.IAmazonS3.EndPutObject ( IAsyncResult  asyncResult)

Finishes the asynchronous execution of the PutObject operation.

See Also
Amazon.S3.IAmazonS3.PutObject

Parameters
asyncResultThe IAsyncResult returned by the call to BeginPutObject.
Returns
Returns a PutObjectResult from AmazonS3.

Implemented in Amazon.S3.AmazonS3Client.

UploadPartResponse Amazon.S3.IAmazonS3.EndUploadPart ( IAsyncResult  asyncResult)

Finishes the asynchronous execution of the UploadPart operation.

See Also
Amazon.S3.IAmazonS3.UploadPart

Parameters
asyncResultThe IAsyncResult returned by the call to BeginUploadPart.
Returns
Returns a UploadPartResult from AmazonS3.

Implemented in Amazon.S3.AmazonS3Client.

void Amazon.S3.IAmazonS3.GetObject ( GetObjectRequest  getObjectRequest,
Action< GetObjectResponse responseCallback 
)

Retrieves objects from Amazon S3.

Parameters
getObjectRequestContainer for the necessary parameters to execute the GetObject service method on AmazonS3.
responseCallbackThe response action that's called when the operation is complete. Upon Failure, the response will be returned with a null parameter
Returns
The response from the GetObject service method, as returned by AmazonS3.

Implemented in Amazon.S3.AmazonS3Client.

string Amazon.S3.IAmazonS3.GetPreSignedURL ( GetPreSignedUrlRequest  request)

Create a signed URL allowing access to a resource that would usually require authentication.

When using query string authentication you create a query, specify an expiration time for the query, sign it with your signature, place the data in an HTTP request, and distribute the request to a user or embed the request in a web page.

A PreSigned URL can be generated for GET, PUT, DELETE and HEAD operations on your bucketName, keys, and versions.

Parameters
requestThe GetPreSignedUrlRequest that defines the parameters of the operation.
Returns
A string that is the signed http request.
Exceptions
T:System.ArgumentException
Exceptions
T:System.ArgumentNullException

Implemented in Amazon.S3.AmazonS3Client.

void Amazon.S3.IAmazonS3.InitiateMultipartUpload ( InitiateMultipartUploadRequest  initiateMultipartUploadRequest,
Action< InitiateMultipartUploadResponse responseCallback 
)

Initiates a multipart upload and returns an upload ID.

After you initiate a multipart upload and upload one or more parts, you must either complete or abort the multipart upload in order to stop getting charged for storage of the uploaded parts. Once you complete or abort the multipart upload, Amazon S3 will release the stored parts and stop charging you for their storage.

Parameters
initiateMultipartUploadRequestContainer for the necessary parameters to execute the InitiateMultipartUpload service method on AmazonS3.
responseCallbackThe response action that's called when the operation is complete. Upon Failure, the response will be returned with a null parameter
Returns
The response from the InitiateMultipartUpload service method, as returned by AmazonS3.

Implemented in Amazon.S3.AmazonS3Client.

void Amazon.S3.IAmazonS3.ListBuckets ( ListBucketsRequest  listBucketsRequest,
Action< ListBucketsResponse responseCallback 
)

Returns a list of all buckets owned by the authenticated sender of the request.

Parameters
listBucketsRequestContainer for the necessary parameters to execute the ListBuckets service method on AmazonS3.
responseCallbackThe response action that's called when the operation is complete. Upon Failure, the response will be returned with a null parameter
Returns
The response from the ListBuckets service method, as returned by AmazonS3.

Implemented in Amazon.S3.AmazonS3Client.

void Amazon.S3.IAmazonS3.ListMultipartUploads ( ListMultipartUploadsRequest  listMultipartUploadsRequest,
Action< ListMultipartUploadsResponse responseCallback 
)

This operation lists in-progress multipart uploads.

Parameters
listMultipartUploadsRequestContainer for the necessary parameters to execute the ListMultipartUploads service method on AmazonS3.
responseCallbackThe response action that's called when the operation is complete. Upon Failure, the response will be returned with a null parameter
Returns
The response from the ListMultipartUploads service method, as returned by AmazonS3.

Implemented in Amazon.S3.AmazonS3Client.

void Amazon.S3.IAmazonS3.ListObjects ( ListObjectsRequest  listObjectsRequest,
Action< ListObjectsResponse responseCallback 
)

Returns some or all (up to 1000) 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.

Parameters
listObjectsRequestContainer for the necessary parameters to execute the ListObjects service method on AmazonS3.
responseCallbackThe response action that's called when the operation is complete. Upon Failure, the response will be returned with a null parameter
Returns
The response from the ListObjects service method, as returned by AmazonS3.

Implemented in Amazon.S3.AmazonS3Client.

void Amazon.S3.IAmazonS3.PutBucket ( PutBucketRequest  putBucketRequest,
Action< PutBucketResponse responseCallback 
)

Creates a new bucket.

Parameters
putBucketRequestContainer for the necessary parameters to execute the PutBucket service method on AmazonS3.
Parameters
responseCallbackThe response action that's called when the operation is complete. Upon Failure, the response will be returned with a null parameter

Implemented in Amazon.S3.AmazonS3Client.

void Amazon.S3.IAmazonS3.PutObject ( PutObjectRequest  putObjectRequest,
Action< PutObjectResponse responseCallback 
)

Adds an object to a bucket.

Parameters
putObjectRequestContainer for the necessary parameters to execute the PutObject service method on AmazonS3.
responseCallbackThe response action that's called when the operation is complete. Upon Failure, the response will be returned with a null parameter
Returns
The response from the PutObject service method, as returned by AmazonS3.

Implemented in Amazon.S3.AmazonS3Client.

void Amazon.S3.IAmazonS3.UploadPart ( UploadPartRequest  uploadPartRequest,
Action< UploadPartResponse responseCallback 
)

Uploads a part in a multipart upload.

After you initiate a multipart upload and upload one or more parts, you must either complete or abort the multipart upload in order to stop getting charged for storage of the uploaded parts. Once you complete or abort the multipart upload, Amazon S3 will release the stored parts and stop charging you for their storage.

Parameters
uploadPartRequestContainer for the necessary parameters to execute the UploadPart service method on AmazonS3.
responseCallbackThe response action that's called when the operation is complete. Upon Failure, the response will be returned with a null parameter
Returns
The response from the UploadPart service method, as returned by AmazonS3.

Implemented in Amazon.S3.AmazonS3Client.


The documentation for this interface was generated from the following files: