AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Namespace: Amazon.S3
Assembly: AWSSDK.dll
Version: (assembly version)
public class AmazonS3Client : AmazonServiceClient IAmazonS3, IDisposable
The AmazonS3Client type exposes the following members
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="AWSProfileName" value="AWS Default"/> </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="AWSProfileName" value="AWS Default"/> </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="AWSProfileName" value="AWS Default"/> </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. | |
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. |
Name | Description | |
---|---|---|
AbortMultipartUpload(string, string, string) |
Aborts a multipart upload.
To verify that all parts have been removed, so you don't get charged for the part storage, you should call the List Parts operation and ensure the parts list is empty. |
|
AbortMultipartUpload(AbortMultipartUploadRequest) |
Aborts a multipart upload.
To verify that all parts have been removed, so you don't get charged for the part storage, you should call the List Parts operation and ensure the parts list is empty. |
|
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(string, string, string, string) | Creates a copy of an object that is already stored in Amazon S3. | |
CopyObject(string, string, string, string, string) | Creates a copy of an object that is already stored in Amazon S3. | |
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(string, string, string, string, string) | Uploads a part by copying data from an existing object as data source. | |
CopyPart(string, string, string, string, string, string) | Uploads a part by copying data from an existing object as data source. | |
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(string) | 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. | |
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(string) | Deletes the policy from the bucket. | |
DeleteBucketPolicy(DeleteBucketPolicyRequest) | Deletes the policy from the bucket. | |
DeleteBucketPolicyAsync(DeleteBucketPolicyRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteBucketPolicy operation. | |
DeleteBucketReplication(DeleteBucketReplicationRequest) | Deletes the replication configuration for the given Amazon S3 bucket. | |
DeleteBucketReplicationAsync(DeleteBucketReplicationRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteBucketReplication operation. | |
DeleteBucketTagging(string) | Deletes the tags from the bucket. | |
DeleteBucketTagging(DeleteBucketTaggingRequest) | Deletes the tags from the bucket. | |
DeleteBucketTaggingAsync(DeleteBucketTaggingRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteBucketTagging operation. | |
DeleteBucketWebsite(string) | This operation removes the website configuration from the bucket. | |
DeleteBucketWebsite(DeleteBucketWebsiteRequest) | This operation removes the website configuration from the bucket. | |
DeleteBucketWebsiteAsync(DeleteBucketWebsiteRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteBucketWebsite operation. | |
DeleteCORSConfiguration(string) | Deletes the cors configuration information set for the bucket. | |
DeleteCORSConfiguration(DeleteCORSConfigurationRequest) | Deletes the cors configuration information set for the bucket. | |
DeleteCORSConfigurationAsync(DeleteCORSConfigurationRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteCORSConfiguration operation. | |
DeleteLifecycleConfiguration(string) | Deletes the lifecycle configuration from the bucket. | |
DeleteLifecycleConfiguration(DeleteLifecycleConfigurationRequest) | Deletes the lifecycle configuration from the bucket. | |
DeleteLifecycleConfigurationAsync(DeleteLifecycleConfigurationRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteLifecycleConfiguration operation. | |
DeleteObject(string, string) | 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. | |
DeleteObject(string, string, string) | 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. | |
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() | Inherited from Amazon.Runtime.AmazonServiceClient. | |
GetACL(string) | Gets the access control policy for the bucket. | |
GetACL(GetACLRequest) | Gets the access control policy for the bucket. | |
GetACLAsync(GetACLRequest, CancellationToken) | Initiates the asynchronous execution of the GetACL operation. | |
GetBucketLocation(string) | Returns the region the bucket resides in. | |
GetBucketLocation(GetBucketLocationRequest) | Returns the region the bucket resides in. | |
GetBucketLocationAsync(GetBucketLocationRequest, CancellationToken) | Initiates the asynchronous execution of the GetBucketLocation operation. | |
GetBucketLogging(string) | 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. | |
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(string) | Returns the notification configuration of a bucket. | |
GetBucketNotification(GetBucketNotificationRequest) | Returns the notification configuration of a bucket. | |
GetBucketNotificationAsync(GetBucketNotificationRequest, CancellationToken) | Initiates the asynchronous execution of the GetBucketNotification operation. | |
GetBucketPolicy(string) | Returns the policy of a specified bucket. | |
GetBucketPolicy(GetBucketPolicyRequest) | Returns the policy of a specified bucket. | |
GetBucketPolicyAsync(GetBucketPolicyRequest, CancellationToken) | Initiates the asynchronous execution of the GetBucketPolicy operation. | |
GetBucketReplication(GetBucketReplicationRequest) | Retrieves the replication configuration for the given Amazon S3 bucket. | |
GetBucketReplicationAsync(GetBucketReplicationRequest, CancellationToken) | Initiates the asynchronous execution of the GetBucketReplication operation. | |
GetBucketRequestPayment(string) | Returns the request payment configuration of a bucket. | |
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(string) | Returns the versioning state of a bucket. | |
GetBucketVersioning(GetBucketVersioningRequest) | Returns the versioning state of a bucket. | |
GetBucketVersioningAsync(GetBucketVersioningRequest, CancellationToken) | Initiates the asynchronous execution of the GetBucketVersioning operation. | |
GetBucketWebsite(string) | Returns the website configuration for a bucket. | |
GetBucketWebsite(GetBucketWebsiteRequest) | Returns the website configuration for a bucket. | |
GetBucketWebsiteAsync(GetBucketWebsiteRequest, CancellationToken) | Initiates the asynchronous execution of the GetBucketWebsite operation. | |
GetCORSConfiguration(string) | Returns the cors configuration for the bucket. | |
GetCORSConfiguration(GetCORSConfigurationRequest) | Returns the cors configuration for the bucket. | |
GetCORSConfigurationAsync(GetCORSConfigurationRequest, CancellationToken) | Initiates the asynchronous execution of the GetCORSConfiguration operation. | |
GetLifecycleConfiguration(string) | Returns the lifecycle configuration information set on the bucket. | |
GetLifecycleConfiguration(GetLifecycleConfigurationRequest) | Returns the lifecycle configuration information set on the bucket. | |
GetLifecycleConfigurationAsync(GetLifecycleConfigurationRequest, CancellationToken) | Initiates the asynchronous execution of the GetLifecycleConfiguration operation. | |
GetObject(string, string) | Retrieves objects from Amazon S3. | |
GetObject(string, string, string) | Retrieves objects from Amazon S3. | |
GetObject(GetObjectRequest) | Retrieves objects from Amazon S3. | |
GetObjectAsync(GetObjectRequest, CancellationToken) | Initiates the asynchronous execution of the GetObject operation. | |
GetObjectMetadata(string, string) | The HEAD operation retrieves metadata from an object without returning the object itself. This operation is useful if you're only interested in an object's metadata. To use HEAD, you must have READ access to the object. | |
GetObjectMetadata(string, string, string) | The HEAD operation retrieves metadata from an object without returning the object itself. This operation is useful if you're only interested in an object's metadata. To use HEAD, you must have READ access to the object. | |
GetObjectMetadata(GetObjectMetadataRequest) | The HEAD operation retrieves metadata from an object without returning the object itself. This operation is useful if you're only interested in an object's metadata. To use HEAD, you must have READ access to the object. | |
GetObjectMetadataAsync(GetObjectMetadataRequest, CancellationToken) | Initiates the asynchronous execution of the GetObjectMetadata operation. | |
GetObjectTorrent(string, string) | Return torrent files from a bucket. | |
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(string, string) |
Initiates a multipart upload and returns an upload ID.
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. |
|
InitiateMultipartUpload(InitiateMultipartUploadRequest) |
Initiates a multipart upload and returns an upload ID.
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. |
|
InitiateMultipartUploadAsync(InitiateMultipartUploadRequest, CancellationToken) | Initiates the asynchronous execution of the InitiateMultipartUpload operation. | |
ListBuckets() | Returns a list of all buckets owned by the authenticated sender of the request. | |
ListBuckets(ListBucketsRequest) | 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(string) | This operation lists in-progress multipart uploads. | |
ListMultipartUploads(string, string) | This operation lists in-progress multipart uploads. | |
ListMultipartUploads(ListMultipartUploadsRequest) | This operation lists in-progress multipart uploads. | |
ListMultipartUploadsAsync(ListMultipartUploadsRequest, CancellationToken) | Initiates the asynchronous execution of the ListMultipartUploads operation. | |
ListObjects(string) | 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. | |
ListObjects(string, string) | 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. | |
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(string, string, string) | Lists the parts that have been uploaded for a specific multipart upload. | |
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(string) | Returns metadata about all of the versions of objects in a bucket. | |
ListVersions(string, string) | Returns metadata about all of the versions of objects in a bucket. | |
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) | Sets the permissions on a bucket using access control lists (ACL). | |
PutACLAsync(PutACLRequest, CancellationToken) | Initiates the asynchronous execution of the PutACL operation. | |
PutBucket(string) | Creates a new bucket. | |
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(string, string) | Replaces a policy on a bucket. If the bucket already has a policy, the one in this request completely replaces it. | |
PutBucketPolicy(string, string, string) | Replaces a policy on a bucket. If the bucket already has a policy, the one in this request completely replaces it. | |
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. | |
PutBucketReplication(PutBucketReplicationRequest) | Creates a new replication configuration (or replaces an existing one, if present). | |
PutBucketReplicationAsync(PutBucketReplicationRequest, CancellationToken) | Initiates the asynchronous execution of the PutBucketReplication operation. | |
PutBucketRequestPayment(string, RequestPaymentConfiguration) | 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. Documentation on requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html | |
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. Documentation on requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html | |
PutBucketRequestPaymentAsync(PutBucketRequestPaymentRequest, CancellationToken) | Initiates the asynchronous execution of the PutBucketRequestPayment operation. | |
PutBucketTagging(string, List<Tag>) | Sets the tags for a bucket. | |
PutBucketTagging(PutBucketTaggingRequest) | Sets the tags for a bucket. | |
PutBucketTaggingAsync(PutBucketTaggingRequest, CancellationToken) | Initiates the asynchronous execution of the PutBucketTagging operation. | |
PutBucketVersioning(PutBucketVersioningRequest) | Sets 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(string, WebsiteConfiguration) | Set the website configuration for a bucket. | |
PutBucketWebsite(PutBucketWebsiteRequest) | Set the website configuration for a bucket. | |
PutBucketWebsiteAsync(PutBucketWebsiteRequest, CancellationToken) | Initiates the asynchronous execution of the PutBucketWebsite operation. | |
PutCORSConfiguration(string, CORSConfiguration) | Sets the cors configuration for a bucket. | |
PutCORSConfiguration(PutCORSConfigurationRequest) | Sets the cors configuration for a bucket. | |
PutCORSConfigurationAsync(PutCORSConfigurationRequest, CancellationToken) | Initiates the asynchronous execution of the PutCORSConfiguration operation. | |
PutLifecycleConfiguration(string, LifecycleConfiguration) | Sets lifecycle configuration for your bucket. If a lifecycle configuration exists, it replaces it. | |
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(string, string) | Restores an archived copy of an object back into Amazon S3 | |
RestoreObject(string, string, int) | Restores an archived copy of an object back into Amazon S3 | |
RestoreObject(string, string, string) | Restores an archived copy of an object back into Amazon S3 | |
RestoreObject(string, string, string, int) | Restores an archived copy of an object back into Amazon S3 | |
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.
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. |
|
UploadPartAsync(UploadPartRequest, CancellationToken) | Initiates the asynchronous execution of the UploadPart operation. |
Name | Description | |
---|---|---|
AfterResponseEvent | Inherited from Amazon.Runtime.AmazonServiceClient. | |
BeforeRequestEvent | Inherited from Amazon.Runtime.AmazonServiceClient. | |
ExceptionEvent | Inherited from Amazon.Runtime.AmazonServiceClient. |
.NET Framework:
Supported in: 4.5, 4.0, 3.5
.NET for Windows Store apps:
Supported in: Windows 8.1, Windows 8
.NET for Windows Phone:
Supported in: Windows Phone 8.1, Windows Phone 8