Interface ICoreAmazonS3

Namespace

Amazon.Runtime.SharedInterfaces

Assembly

AWSSDK.Core.dll

ICoreAmazonS3 is not meant to use directly. It defines S3 with basic .NET types and allows other services to be able to use S3 as a runtime dependency. This interface is implemented by the AmazonS3Client defined in the S3 assembly.

public interface ICoreAmazonS3

Methods

BeginDelete(string, string, IDictionary<string, object>, AsyncCallback, object)

Start a delete object.

IAsyncResult BeginDelete(string bucketName, string objectKey, IDictionary<string, object> additionalProperties, AsyncCallback callback, object state)

Parameters

bucketName string

objectKey string

additionalProperties IDictionary<string, object>

callback AsyncCallback

state object

Returns

IAsyncResult

BeginDownloadToFilePath(string, string, string, IDictionary<string, object>, AsyncCallback, object)

Start a download to a file path.

IAsyncResult BeginDownloadToFilePath(string bucketName, string objectKey, string filepath, IDictionary<string, object> additionalProperties, AsyncCallback callback, object state)

Parameters

bucketName string

objectKey string

filepath string

additionalProperties IDictionary<string, object>

callback AsyncCallback

state object

Returns

IAsyncResult

BeginGetObjectStream(string, string, IDictionary<string, object>, AsyncCallback, object)

Start opening a stream to an object in S3.

IAsyncResult BeginGetObjectStream(string bucketName, string objectKey, IDictionary<string, object> additionalProperties, AsyncCallback callback, object state)

Parameters

bucketName string

objectKey string

additionalProperties IDictionary<string, object>

callback AsyncCallback

state object

Returns

IAsyncResult

BeginUploadObjectFromFilePath(string, string, string, IDictionary<string, object>, AsyncCallback, object)

Start an upload object from file path.

IAsyncResult BeginUploadObjectFromFilePath(string bucketName, string objectKey, string filepath, IDictionary<string, object> additionalProperties, AsyncCallback callback, object state)

Parameters

bucketName string

objectKey string

filepath string

additionalProperties IDictionary<string, object>

callback AsyncCallback

state object

Returns

IAsyncResult

BeginUploadObjectFromStream(string, string, Stream, IDictionary<string, object>, AsyncCallback, object)

Start an upload object from stream.

IAsyncResult BeginUploadObjectFromStream(string bucketName, string objectKey, Stream stream, IDictionary<string, object> additionalProperties, AsyncCallback callback, object state)

Parameters

bucketName string

objectKey string

stream Stream

additionalProperties IDictionary<string, object>

callback AsyncCallback

state object

Returns

IAsyncResult

Delete(string, string, IDictionary<string, object>)

Delete the object.

void Delete(string bucketName, string objectKey, IDictionary<string, object> additionalProperties)

Parameters

bucketName string

objectKey string

additionalProperties IDictionary<string, object>

Deletes(string, IEnumerable<string>, IDictionary<string, object>)

Deletes the ojects.

void Deletes(string bucketName, IEnumerable<string> objectKeys, IDictionary<string, object> additionalProperties)

Parameters

bucketName string

objectKeys IEnumerable<string>

additionalProperties IDictionary<string, object>

DoesS3BucketExist(string)

Check to see if the bucket exists.

bool DoesS3BucketExist(string bucketName)

Parameters

bucketName string

Returns

bool

DownloadToFilePath(string, string, string, IDictionary<string, object>)

Download object to a file path.

void DownloadToFilePath(string bucketName, string objectKey, string filepath, IDictionary<string, object> additionalProperties)

Parameters

bucketName string

objectKey string

filepath string

additionalProperties IDictionary<string, object>

EndDelete(IAsyncResult)

Get the results of a delete object.

void EndDelete(IAsyncResult result)

Parameters

result IAsyncResult

EndDownloadToFilePath(IAsyncResult)

Get results of downloading an object to a file path.

void EndDownloadToFilePath(IAsyncResult result)

Parameters

result IAsyncResult

EndGetObjectStream(IAsyncResult)

Get results of opening a stream to an object in S3.

Stream EndGetObjectStream(IAsyncResult result)

Parameters

result IAsyncResult

Returns

Stream

EndUploadObjectFromFilePath(IAsyncResult)

Get the results of an upload from file path.

void EndUploadObjectFromFilePath(IAsyncResult result)

Parameters

result IAsyncResult

EndUploadObjectFromStream(IAsyncResult)

Get the results of an upload from stream.

void EndUploadObjectFromStream(IAsyncResult result)

Parameters

result IAsyncResult

EnsureBucketExists(string)

Check to see if the bucket exists and if it doesn't create the bucket.

void EnsureBucketExists(string bucketName)

Parameters

bucketName string

GeneratePreSignedURL(string, string, DateTime, IDictionary<string, object>)

Generate a presigned URL.

string GeneratePreSignedURL(string bucketName, string objectKey, DateTime expiration, IDictionary<string, object> additionalProperties)

Parameters

bucketName string

objectKey string

expiration DateTime

additionalProperties IDictionary<string, object>

Returns

string

GetAllObjectKeys(string, string, IDictionary<string, object>)

Get all the object keys for the particular bucket and key prefix.

IList<string> GetAllObjectKeys(string bucketName, string prefix, IDictionary<string, object> additionalProperties)

Parameters

bucketName string

prefix string

additionalProperties IDictionary<string, object>

Returns

IList<string>

GetObjectStream(string, string, IDictionary<string, object>)

Get stream for an object.

Stream GetObjectStream(string bucketName, string objectKey, IDictionary<string, object> additionalProperties)

Parameters

bucketName string

objectKey string

additionalProperties IDictionary<string, object>

Returns

Stream

MakeObjectPublic(string, string, bool)

Set the ACL on the object to public readable.

void MakeObjectPublic(string bucketName, string objectKey, bool enable)

Parameters

bucketName string

objectKey string

enable bool

UploadObjectFromFilePath(string, string, string, IDictionary<string, object>)

Upload an object from a file path.

void UploadObjectFromFilePath(string bucketName, string objectKey, string filepath, IDictionary<string, object> additionalProperties)

Parameters

bucketName string

objectKey string

filepath string

additionalProperties IDictionary<string, object>

UploadObjectFromStream(string, string, Stream, IDictionary<string, object>)

Upload an object from a stream.

void UploadObjectFromStream(string bucketName, string objectKey, Stream stream, IDictionary<string, object> additionalProperties)

Parameters

bucketName string

objectKey string

stream Stream

additionalProperties IDictionary<string, object>