Inheritance Hierarchy
Amazon.Runtime.AbstractWebServiceClient
Amazon.Runtime.AmazonWebServiceClient
Amazon.S3.AmazonS3Client
Namespace: Amazon.S3
Assembly: AWSSDK.dll
Version: 2.0.0.3
Syntax
public class AmazonS3Client : AmazonWebServiceClient IAmazonS3, IDisposable
The AmazonS3Client type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
AmazonS3Client() |
Constructs AmazonS3Client with the credentials loaded from the application's
default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<appSettings>
<add key="AWSAccessKey" value="********************"/>
<add key="AWSSecretKey" value="****************************************"/>
</appSettings>
</configuration>
|
|
|
AmazonS3Client(RegionEndpoint) |
Constructs AmazonS3Client with the credentials loaded from the application's
default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<appSettings>
<add key="AWSAccessKey" value="********************"/>
<add key="AWSSecretKey" value="****************************************"/>
</appSettings>
</configuration>
|
|
|
AmazonS3Client(AmazonS3Config) |
Constructs AmazonS3Client with the credentials loaded from the application's
default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<appSettings>
<add key="AWSAccessKey" value="********************"/>
<add key="AWSSecretKey" value="****************************************"/>
</appSettings>
</configuration>
|
|
|
AmazonS3Client(AWSCredentials) | Constructs AmazonS3Client with AWS Credentials |
|
|
AmazonS3Client(AWSCredentials, RegionEndpoint) | Constructs AmazonS3Client with AWS Credentials |
|
|
AmazonS3Client(AWSCredentials, AmazonS3Config) | Constructs AmazonS3Client with AWS Credentials and an AmazonS3Client Configuration object. |
|
|
AmazonS3Client(string, string) | Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key |
|
|
AmazonS3Client(string, string, RegionEndpoint) | Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key |
|
|
AmazonS3Client(string, string, AmazonS3Config) | Constructs AmazonS3Client with AWS Access Key ID, AWS Secret Key and an AmazonS3Client Configuration object. If the config object's UseSecureStringForAwsSecretKey is false, the AWS Secret Key is stored as a clear-text string. Please use this option only if the application environment doesn't allow the use of SecureStrings. |
|
|
AmazonS3Client(string, string, string) | Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key |
|
|
AmazonS3Client(string, string, string, RegionEndpoint) | Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key |
|
|
AmazonS3Client(string, string, string, AmazonS3Config) | Constructs AmazonS3Client with AWS Access Key ID, AWS Secret Key and an AmazonS3Client Configuration object. If the config object's UseSecureStringForAwsSecretKey is false, the AWS Secret Key is stored as a clear-text string. Please use this option only if the application environment doesn't allow the use of SecureStrings. |
Methods
| Name | Description | |
|---|---|---|
|
|
AbortMultipartUpload(AbortMultipartUploadRequest) |
Aborts a multipart upload. |
|
|
AbortMultipartUploadAsync(AbortMultipartUploadRequest, CancellationToken) |
Initiates the asynchronous execution of the AbortMultipartUpload operation.
|
|
|
CompleteMultipartUpload(CompleteMultipartUploadRequest) |
Completes a multipart upload by assembling previously uploaded parts. |
|
|
CompleteMultipartUploadAsync(CompleteMultipartUploadRequest, CancellationToken) |
Initiates the asynchronous execution of the CompleteMultipartUpload operation.
|
|
|
CopyObject(CopyObjectRequest) |
Creates a copy of an object that is already stored in Amazon S3. |
|
|
CopyObjectAsync(CopyObjectRequest, CancellationToken) |
Initiates the asynchronous execution of the CopyObject operation.
|
|
|
CopyPart(CopyPartRequest) |
Uploads a part by copying data from an existing object as data source. |
|
|
CopyPartAsync(CopyPartRequest, CancellationToken) |
Initiates the asynchronous execution of the CopyPart operation.
|
|
|
DeleteBucket(DeleteBucketRequest) |
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. |
|
|
DeleteBucketAsync(DeleteBucketRequest, CancellationToken) |
Initiates the asynchronous execution of the DeleteBucket operation.
|
|
|
DeleteBucketPolicy(DeleteBucketPolicyRequest) |
Deletes the policy from the bucket. |
|
|
DeleteBucketPolicyAsync(DeleteBucketPolicyRequest, CancellationToken) |
Initiates the asynchronous execution of the DeleteBucketPolicy operation.
|
|
|
DeleteBucketTagging(DeleteBucketTaggingRequest) |
Deletes the tags from the bucket. |
|
|
DeleteBucketTaggingAsync(DeleteBucketTaggingRequest, CancellationToken) |
Initiates the asynchronous execution of the DeleteBucketTagging operation.
|
|
|
DeleteBucketWebsite(DeleteBucketWebsiteRequest) |
This operation removes the website configuration from the bucket. |
|
|
DeleteBucketWebsiteAsync(DeleteBucketWebsiteRequest, CancellationToken) |
Initiates the asynchronous execution of the DeleteBucketWebsite operation.
|
|
|
DeleteCORSConfiguration(DeleteCORSConfigurationRequest) |
Deletes the cors configuration information set for the bucket. |
|
|
DeleteCORSConfigurationAsync(DeleteCORSConfigurationRequest, CancellationToken) |
Initiates the asynchronous execution of the DeleteCORSConfiguration operation.
|
|
|
DeleteLifecycleConfiguration(DeleteLifecycleConfigurationRequest) |
Deletes the lifecycle configuration from the bucket. |
|
|
DeleteLifecycleConfigurationAsync(DeleteLifecycleConfigurationRequest, CancellationToken) |
Initiates the asynchronous execution of the DeleteLifecycleConfiguration operation.
|
|
|
DeleteObject(DeleteObjectRequest) |
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. |
|
|
DeleteObjectAsync(DeleteObjectRequest, CancellationToken) |
Initiates the asynchronous execution of the DeleteObject operation.
|
|
|
DeleteObjects(DeleteObjectsRequest) |
This operation enables you to delete multiple objects from a bucket using a single HTTP request. You may specify up to 1000 keys. |
|
|
DeleteObjectsAsync(DeleteObjectsRequest, CancellationToken) |
Initiates the asynchronous execution of the DeleteObjects operation.
|
|
|
Dispose() | Disposes of all managed and unmanaged resources. |
|
|
GetACL(GetACLRequest) |
Returns the access control list (ACL) of an object. |
|
|
GetACLAsync(GetACLRequest, CancellationToken) |
Initiates the asynchronous execution of the GetACL operation.
|
|
|
GetBucketLocation(GetBucketLocationRequest) |
Returns the region the bucket resides in. |
|
|
GetBucketLocationAsync(GetBucketLocationRequest, CancellationToken) |
Initiates the asynchronous execution of the GetBucketLocation operation.
|
|
|
GetBucketLogging(GetBucketLoggingRequest) |
Returns the logging status of a bucket and the permissions users have to view and modify that status. To use GET, you must be the bucket owner. |
|
|
GetBucketLoggingAsync(GetBucketLoggingRequest, CancellationToken) |
Initiates the asynchronous execution of the GetBucketLogging operation.
|
|
|
GetBucketNotification(GetBucketNotificationRequest) |
Return the notification configuration of a bucket. |
|
|
GetBucketNotificationAsync(GetBucketNotificationRequest, CancellationToken) |
Initiates the asynchronous execution of the GetBucketNotification operation.
|
|
|
GetBucketPolicy(GetBucketPolicyRequest) |
Returns the policy of a specified bucket. |
|
|
GetBucketPolicyAsync(GetBucketPolicyRequest, CancellationToken) |
Initiates the asynchronous execution of the GetBucketPolicy operation.
|
|
|
GetBucketRequestPayment(GetBucketRequestPaymentRequest) |
Returns the request payment configuration of a bucket. |
|
|
GetBucketRequestPaymentAsync(GetBucketRequestPaymentRequest, CancellationToken) |
Initiates the asynchronous execution of the GetBucketRequestPayment operation.
|
|
|
GetBucketTagging(GetBucketTaggingRequest) |
Returns the tag set associated with the bucket. |
|
|
GetBucketTaggingAsync(GetBucketTaggingRequest, CancellationToken) |
Initiates the asynchronous execution of the GetBucketTagging operation.
|
|
|
GetBucketVersioning(GetBucketVersioningRequest) |
Returns the versioning state of a bucket. |
|
|
GetBucketVersioningAsync(GetBucketVersioningRequest, CancellationToken) |
Initiates the asynchronous execution of the GetBucketVersioning operation.
|
|
|
GetBucketWebsite(GetBucketWebsiteRequest) |
Returns the website configuration for a bucket. |
|
|
GetBucketWebsiteAsync(GetBucketWebsiteRequest, CancellationToken) |
Initiates the asynchronous execution of the GetBucketWebsite operation.
|
|
|
GetCORSConfiguration(GetCORSConfigurationRequest) |
Returns the cors configuration for the bucket. |
|
|
GetCORSConfigurationAsync(GetCORSConfigurationRequest, CancellationToken) |
Initiates the asynchronous execution of the GetCORSConfiguration operation.
|
|
|
GetLifecycleConfiguration(GetLifecycleConfigurationRequest) |
Returns the lifecycle configuration information set on the bucket. |
|
|
GetLifecycleConfigurationAsync(GetLifecycleConfigurationRequest, CancellationToken) |
Initiates the asynchronous execution of the GetLifecycleConfiguration operation.
|
|
|
GetObject(GetObjectRequest) |
Retrieves objects from Amazon S3. |
|
|
GetObjectAsync(GetObjectRequest, CancellationToken) |
Initiates the asynchronous execution of the GetObject operation.
|
|
|
GetObjectMetadata(GetObjectMetadataRequest) | Returns information about a specified object. |
|
|
GetObjectMetadataAsync(GetObjectMetadataRequest, CancellationToken) |
Initiates the asynchronous execution of the GetObjectMetadata operation.
|
|
|
GetObjectTorrent(GetObjectTorrentRequest) |
Return torrent files from a bucket. |
|
|
GetObjectTorrentAsync(GetObjectTorrentRequest, CancellationToken) |
Initiates the asynchronous execution of the GetObjectTorrent operation.
|
|
|
GetPreSignedURL(GetPreSignedUrlRequest) | Create a signed URL allowing access to a resource that would usually require authentication. |
|
|
InitiateMultipartUpload(InitiateMultipartUploadRequest) |
Initiates a multipart upload and returns an upload ID. |
|
|
InitiateMultipartUploadAsync(InitiateMultipartUploadRequest, CancellationToken) |
Initiates the asynchronous execution of the InitiateMultipartUpload operation.
|
|
|
ListBuckets(ListBucketsRequest) |
Returns a list of all buckets owned by the authenticated sender of the request. |
|
|
ListBuckets() |
Returns a list of all buckets owned by the authenticated sender of the request. |
|
|
ListBucketsAsync(ListBucketsRequest, CancellationToken) |
Initiates the asynchronous execution of the ListBuckets operation.
|
|
|
ListMultipartUploads(ListMultipartUploadsRequest) |
This operation lists in-progress multipart uploads. |
|
|
ListMultipartUploadsAsync(ListMultipartUploadsRequest, CancellationToken) |
Initiates the asynchronous execution of the ListMultipartUploads operation.
|
|
|
ListObjects(ListObjectsRequest) |
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. |
|
|
ListObjectsAsync(ListObjectsRequest, CancellationToken) |
Initiates the asynchronous execution of the ListObjects operation.
|
|
|
ListParts(ListPartsRequest) |
Lists the parts that have been uploaded for a specific multipart upload. |
|
|
ListPartsAsync(ListPartsRequest, CancellationToken) |
Initiates the asynchronous execution of the ListParts operation.
|
|
|
ListVersions(ListVersionsRequest) |
Returns metadata about all of the versions of objects in a bucket. |
|
|
ListVersionsAsync(ListVersionsRequest, CancellationToken) |
Initiates the asynchronous execution of the ListVersions operation.
|
|
|
PutACL(PutACLRequest) |
uses the acl subresource to set the access control list (ACL) permissions for an object that already exists in a bucket |
|
|
PutACLAsync(PutACLRequest, CancellationToken) |
Initiates the asynchronous execution of the PutACL operation.
|
|
|
PutBucket(PutBucketRequest) |
Creates a new bucket. |
|
|
PutBucketAsync(PutBucketRequest, CancellationToken) |
Initiates the asynchronous execution of the PutBucket operation.
|
|
|
PutBucketLogging(PutBucketLoggingRequest) |
Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters. To set the logging status of a bucket, you must be the bucket owner. |
|
|
PutBucketLoggingAsync(PutBucketLoggingRequest, CancellationToken) |
Initiates the asynchronous execution of the PutBucketLogging operation.
|
|
|
PutBucketNotification(PutBucketNotificationRequest) |
Enables notifications of specified events for a bucket. |
|
|
PutBucketNotificationAsync(PutBucketNotificationRequest, CancellationToken) |
Initiates the asynchronous execution of the PutBucketNotification operation.
|
|
|
PutBucketPolicy(PutBucketPolicyRequest) |
Replaces a policy on a bucket. If the bucket already has a policy, the one in this request completely replaces it. |
|
|
PutBucketPolicyAsync(PutBucketPolicyRequest, CancellationToken) |
Initiates the asynchronous execution of the PutBucketPolicy operation.
|
|
|
PutBucketRequestPayment(PutBucketRequestPaymentRequest) |
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. |
|
|
PutBucketRequestPaymentAsync(PutBucketRequestPaymentRequest, CancellationToken) |
Initiates the asynchronous execution of the PutBucketRequestPayment operation.
|
|
|
PutBucketTagging(PutBucketTaggingRequest) |
Sets the tags for a bucket. |
|
|
PutBucketTaggingAsync(PutBucketTaggingRequest, CancellationToken) |
Initiates the asynchronous execution of the PutBucketTagging operation.
|
|
|
PutBucketVersioning(PutBucketVersioningRequest) |
Puts the versioning state of an existing bucket. To set the versioning state, you must be the bucket owner. |
|
|
PutBucketVersioningAsync(PutBucketVersioningRequest, CancellationToken) |
Initiates the asynchronous execution of the PutBucketVersioning operation.
|
|
|
PutBucketWebsite(PutBucketWebsiteRequest) |
Set the website configuration for a bucket. |
|
|
PutBucketWebsiteAsync(PutBucketWebsiteRequest, CancellationToken) |
Initiates the asynchronous execution of the PutBucketWebsite operation.
|
|
|
PutCORSConfiguration(PutCORSConfigurationRequest) |
Sets the cors configuration for a bucket. |
|
|
PutCORSConfigurationAsync(PutCORSConfigurationRequest, CancellationToken) |
Initiates the asynchronous execution of the PutCORSConfiguration operation.
|
|
|
PutLifecycleConfiguration(PutLifecycleConfigurationRequest) |
Sets lifecycle configuration for your bucket. If a lifecycle configuration exists, it replaces it. |
|
|
PutLifecycleConfigurationAsync(PutLifecycleConfigurationRequest, CancellationToken) |
Initiates the asynchronous execution of the PutLifecycleConfiguration operation.
|
|
|
PutObject(PutObjectRequest) |
Adds an object to a bucket. |
|
|
PutObjectAsync(PutObjectRequest, CancellationToken) |
Initiates the asynchronous execution of the PutObject operation.
|
|
|
RestoreObject(RestoreObjectRequest) |
Restores an archived copy of an object back into Amazon S3 |
|
|
RestoreObjectAsync(RestoreObjectRequest, CancellationToken) |
Initiates the asynchronous execution of the RestoreObject operation.
|
|
|
UploadPart(UploadPartRequest) |
Uploads a part in a multipart upload. |
|
|
UploadPartAsync(UploadPartRequest, CancellationToken) |
Initiates the asynchronous execution of the UploadPart operation.
|
Version Information
.NET Framework:
Supported in: 4.5, 4.0, 3.5
.NET for Windows Store apps:
Supported in: Windows 8
.NET for Windows Phone:
Supported in: Window Phone 8
