AWS SDK Version 2 for .NET
API Reference

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.

.NET Framework 4.5
 
 

Classes

NameDescription
Class AbortMultipartUploadRequest The parameters to request an abort of a multipart upload.
Class AbortMultipartUploadResponse Returns information about the AbortMultipartUpload response metadata. The AbortMultipartUpload operation has a void result type.
Class ByteRange This class represents the byte range for a range GET from S3.
Class CloudFunctionConfiguration This class contains the configuration Amazon S3 uses to figure out what events you want to listen and send the event to an Amazon Lambda cloud function.
Class CompleteMultipartUploadRequest Container for the parameters to the CompleteMultipartUpload operation.

Completes a multipart upload by assembling previously uploaded parts.
Class CompleteMultipartUploadResponse Returns information about the CompleteMultipartUpload response and response metadata.
Class CopyObjectRequest Container for the parameters to the CopyObject operation.

Creates a copy of an object that is already stored in Amazon S3.
Class CopyObjectResponse Returns information about the CopyObject response and response metadata.
Class CopyPartRequest Container for the parameters to the CopyPart operation.

Uploads a part by copying data from an existing object as data source.
Class CopyPartResponse Returns information about the CopyPart response and response metadata.
Class CORSConfiguration A collection of up to 100 cross-origin resource sharing (CORS) rules.
Class CORSRule C O R S Rule
Class DeleteBucketPolicyRequest Container for the parameters to the DeleteBucketPolicy operation.

Deletes the policy from the bucket.
Class DeleteBucketPolicyResponse Returns information about the DeleteBucketPolicy response metadata. The DeleteBucketPolicy operation has a void result type.
Class DeleteBucketReplicationRequest
Class DeleteBucketReplicationResponse Returns information about the DeleteBucketReplication response metadata. The DeleteBucketReplication operation has a void result type.
Class DeleteBucketRequest Container for the parameters to the DeleteBucket operation.

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.
Class DeleteBucketResponse Returns information about the DeleteBucket response metadata. The DeleteBucket operation has a void result type.
Class DeleteBucketTaggingRequest The parameters to request deletion of a tag set from a bucket.
Class DeleteBucketTaggingResponse Returns information about the DeleteBucketTagging response metadata. The DeleteBucketTagging operation has a void result type.
Class DeleteBucketWebsiteRequest Container for the parameters to the DeleteBucketWebsite operation.

This operation removes the website configuration from the bucket.
Class DeleteBucketWebsiteResponse Returns information about the DeleteBucketWebsite response metadata. The DeleteBucketWebsite operation has a void result type.
Class DeleteCORSConfigurationRequest Container for the parameters to the DeleteCORSConfiguration operation.

Deletes the cors configuration information set for the bucket.
Class DeleteCORSConfigurationResponse Returns information about the DeleteCORSConfiguration response metadata. The DeleteCORSConfiguration operation has a void result type.
Class DeletedObject Contains information about a successful delete operation against a specific S3 object.
Class DeleteError Contains information about a failed delete operation against a specific S3 object.
Class DeleteLifecycleConfigurationRequest The parameters to request deletion of the lifecycle configuration on a bucket.
Class DeleteLifecycleConfigurationResponse Returns information about the DeleteLifecycleConfiguration response metadata. The DeleteLifecycleConfiguration operation has a void result type.
Class DeleteObjectRequest The parameters to request deletion of an object in a bucket. The operation removes the null version (if there is one) of an object and inserts a delete marker, which becomes the latest version of the object.
Class DeleteObjectResponse Returns information about the DeleteObject response and response metadata.
Class DeleteObjectsRequest Container for the parameters to the DeleteObjects operation.

This operation enables you to delete multiple objects from a bucket using a single HTTP request. You may specify up to 1000 keys.
Class DeleteObjectsResponse Returns information about the DeleteObjects response and response metadata.
Class Expiration Defines the expiration policy for a given object.
Class Filter Bucket Represents a set of filter criteria that limits the objects that can trigger event notifications
Class FilterRule Bucket Represents a Filter Rule for a NotificationConfiguration.
Class GetACLRequest Container for the parameters to the GetACL operation.

Returns the access control list (ACL) of an object.
Class GetACLResponse Returns information about the GetACL response and response metadata.
Class GetBucketLocationRequest Container for the parameters to the GetBucketLocation operation.

Returns the region the bucket resides in.
Class GetBucketLocationResponse Returns information about the GetBucketLocation response and response metadata.
Class GetBucketLoggingRequest Container for the parameters to the GetBucketLogging operation.

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.
Class GetBucketLoggingResponse Returns information about the GetBucketLogging response and response metadata.
Class GetBucketNotificationRequest Container for the parameters to the GetBucketNotification operation.

Return the notification configuration of a bucket.
Class GetBucketNotificationResponse Returns information about the GetBucketNotification response and response metadata.
Class GetBucketPolicyRequest Container for the parameters to the GetBucketPolicy operation.

Returns the policy of a specified bucket.
Class GetBucketPolicyResponse Get BucketName Policy Response
Class GetBucketReplicationRequest Container for the parameters to the GetBucketReplicationConfiguration operation.

Returns the replication configuration information set on the bucket.
Class GetBucketReplicationResponse Returns information about the GetReplicationConfiguration response and response metadata.
Class GetBucketRequestPaymentRequest Container for the parameters to the GetBucketRequestPayment operation.

Returns the request payment configuration of a bucket.
Class GetBucketRequestPaymentResponse Returns information about the GetBucketRequestPayment response and response metadata.
Class GetBucketTaggingRequest Container for the parameters to the GetBucketTagging operation.

Returns the tag set associated with the bucket.
Class GetBucketTaggingResponse Returns information about the GetBucketTagging response and response metadata.
Class GetBucketVersioningRequest Container for the parameters to the GetBucketVersioning operation.

Returns the versioning state of a bucket.
Class GetBucketVersioningResponse Returns information about the GetBucketVersioning response and response metadata.
Class GetBucketWebsiteRequest Container for the parameters to the GetBucketWebsite operation.

Returns the website configuration for a bucket.
Class GetBucketWebsiteResponse Returns information about the GetBucketWebsite response and response metadata.
Class GetCORSConfigurationRequest Container for the parameters to the GetBucketCors operation.

Returns the cors configuration for the bucket.
Class GetCORSConfigurationResponse Returns information about the GetBucketCors response and response metadata.
Class GetLifecycleConfigurationRequest Container for the parameters to the GetLifecycleConfiguration operation.

Returns the lifecycle configuration information set on the bucket.
Class GetLifecycleConfigurationResponse Returns information about the GetLifecycleConfiguration response and response metadata.
Class GetObjectMetadataRequest Container for the parameters to the HeadObject operation.

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.
Class GetObjectMetadataResponse Returns information about the HeadObject response and response metadata.
Class GetObjectRequest Container for the parameters to the GetObject operation.

Retrieves objects from Amazon S3.
Class GetObjectResponse Returns information about the GetObject response and response metadata.
Class GetObjectTorrentRequest Container for the parameters to the GetObjectTorrent operation.

Return torrent files from a bucket.
Class GetObjectTorrentResponse Returns information about the GetObjectTorrent response and response metadata.
Class GetPreSignedUrlRequest The parameters to create a pre-signed URL to a bucket or object.
Class HeadersCollection This class contains the headers for an S3 object.
Class InitiateMultipartUploadRequest Container for the parameters to the InitiateMultipartUpload operation.

Initiates a multipart upload and returns an upload ID.
Class InitiateMultipartUploadResponse Returns information about the InitiateMultipartUpload response and response metadata.
Class Initiator

Identifies who initiated the multipart upload.
Class KeyVersion Specifies an object key and optional object version.
Class LambdaFunctionConfiguration This class contains the configuration Amazon S3 uses to figure out what events you want to listen and send the event to an Amazon Lambda cloud function.
Class LifecycleConfiguration Lifecycle Configuration
Class LifecycleRule Rules Item
Class LifecycleRuleExpiration Expiration
Class LifecycleRuleNoncurrentVersionExpiration Noncurrent Version Expiration
Class LifecycleRuleNoncurrentVersionTransition LifecycleTransition defines when and how objects transition.
Class LifecycleTransition LifecycleTransition defines when and how objects transition.
Class ListBucketsRequest Container for the parameters to the ListBuckets operation.

Returns a list of all buckets owned by the authenticated sender of the request.
Class ListBucketsResponse Returns information about the ListBuckets response and response metadata.
Class ListMultipartUploadsRequest Container for the parameters to the ListMultipartUploads operation.

This operation lists in-progress multipart uploads.
Class ListMultipartUploadsResponse Returns information about the ListMultipartUploads response and response metadata.
Class ListObjectsRequest Container for the parameters to the ListObjects operation.

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.
Class ListObjectsResponse Returns information about the ListObjects response and response metadata.
Class ListPartsRequest Container for the parameters to the ListParts operation.

Lists the parts that have been uploaded for a specific multipart upload.
Class ListPartsResponse Returns information about the ListParts response and response metadata.
Class ListVersionsRequest Container for the parameters to the ListVersions operation.

Returns metadata about all of the versions of objects in a bucket.
Class ListVersionsResponse Returns information about the ListVersions response and response metadata.
Class MetadataCollection This class contains the meta data for an S3 object.
Class MfaCodes This class contains the mfa codes used authentication
Class MultipartUpload Container for elements related to a particular multipart upload.
Class NotificationConfiguration An abstract class for all the notification configurations associated with an Amazon S3 bucket.
Class Owner The owner of an S3 bucket.
Class PartDetail A container for elements related to a particular part in a multipart operation. A response can contain zero or more Part elements.
Class PartETag A container holding the part number and etag used when completing a multipart upload.
Class PutACLRequest Container for the parameters to the PutAcl operation.

uses the acl subresource to set the access control list (ACL) permissions for an object that already exists in a bucket
Class PutACLResponse Returns information about the PutObjectAcl response metadata. The PutAcl operation has a void result type.
Class PutBucketLoggingRequest Container for the parameters to the PutBucketLoggingRequest operation.

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.
Class PutBucketLoggingResponse Returns information about the PutBucketLogging response metadata. The EnableBucketLogging operation has a void result type.
Class PutBucketNotificationRequest Container for the parameters to the PutBucketNotification operation.

Enables notifications of specified events for a bucket.
Class PutBucketNotificationResponse Returns information about the PutBucketNotification response metadata. The PutBucketNotification operation has a void result type.
Class PutBucketPolicyRequest Container for the parameters to the PutBucketPolicy operation.

Replaces a policy on a bucket. If the bucket already has a policy, the one in this request completely replaces it.
Class PutBucketPolicyResponse Returns information about the PutBucketPolicy response metadata. The PutBucketPolicy operation has a void result type.
Class PutBucketReplicationRequest Container for the parameters to the PutBucketReplication operation.

Sets replication configuration for your bucket. If a replication configuration exists, this replaces it.
Class PutBucketReplicationResponse Returns information about the PutBucketReplicationConfiguration response metadata. The PutBucketReplicationConfiguration operation has a void result type.
Class PutBucketRequest Container for the parameters to the PutBucket operation.

Creates a new bucket.
Class PutBucketRequestPaymentRequest Container for the parameters to the PutBucketRequestPayment operation.

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.
Class PutBucketRequestPaymentResponse Returns information about the PutBucketRequestPayment response metadata. The PutBucketRequestPayment operation has a void result type.
Class PutBucketResponse Returns information about the PutBucket response and response metadata.
Class PutBucketTaggingRequest Container for the parameters to the PutBucketTagging operation.

Sets the tags for a bucket.
Class PutBucketTaggingResponse Returns information about the PutBucketTagging response metadata. The PutBucketTagging operation has a void result type.
Class PutBucketVersioningRequest Container for the parameters to the PutBucketVersioning operation.

Sets the versioning state of an existing bucket. To set the versioning state, you must be the bucket owner.
Class PutBucketVersioningResponse Returns information about the PutBucketVersioning response metadata. The PutBucketVersioning operation has a void result type.
Class PutBucketWebsiteRequest Container for the parameters to the PutBucketWebsite operation.

Set the website configuration for a bucket.
Class PutBucketWebsiteResponse Returns information about the PutBucketWebsite response metadata. The PutBucketWebsite operation has a void result type.
Class PutCORSConfigurationRequest Container for the parameters to the PutCORSConfiguration operation.

Sets the cors configuration for a bucket.
Class PutCORSConfigurationResponse Returns information about the PutCORSConfiguration response metadata. The PutCORSConfiguration operation has a void result type.
Class PutLifecycleConfigurationRequest Container for the parameters to the PutLifecycleConfiguration operation.

Sets lifecycle configuration for your bucket. If a lifecycle configuration exists, it replaces it.
Class PutLifecycleConfigurationResponse Returns information about the PutLifecycleConfiguration response metadata. The PutLifecycleConfiguration operation has a void result type.
Class PutObjectRequest Container for the parameters to the PutObject operation.

Adds an object to a bucket.
Class PutObjectResponse Returns information about the PutObject response and response metadata.
Class PutWithACLRequest
Class QueueConfiguration This class contains the configuration Amazon S3 uses to figure out what events you want to listen and send the event to an Amazon SQS queue.

The queue's policy must allow S3 to send messages to it. The utility method Amazon.SQS.AmazonSQSClient.AuthorizeS3ToSendMessage(System.String,System.String) can be used to help setup the queue policy.

Class ReplicationConfiguration
Class ReplicationDestination Destination configuration for a replication rule.
Class ReplicationRule Rule that specifies the replication configuration.
Class RequestPaymentConfiguration Request Payment Configuration
Class ResponseHeaderOverrides Container for values of the response headers that will be set on a response from a GetObject request. These values override any headers that were set when the object was uploaded to S3.
Class RestoreObjectRequest Container for the parameters to the RestoreObject operation.

Restores an archived copy of an object back into Amazon S3
Class RestoreObjectResponse Returns information about the RestoreObject response metadata. The RestoreObject operation has a void result type.
Class RoutingRule Routing Rule
Class RoutingRuleCondition

A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the /docs folder, redirect to the /documents folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might process the error.
Class RoutingRuleRedirect

Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event of an error, you can can specify a different error code to return.
Class S3AccessControlList Represents an access control list (ACL) for S3. An AccessControlList is represented by an Owner, and a List of Grants, where each Grant is a Grantee and a Permission.
Class S3Bucket Bucket Represents an S3 bucket, contains the name of the S3 bucket and the date that the bucket was created.
Class S3BucketLoggingConfig Logging Enabled
Class S3BucketVersioningConfig An S3 bucket versioning configuration.
Class S3Grant Grant
Class S3Grantee Grantee
Class S3KeyFilter Filter criteria that allows for event notification filtering based on an S3 Object's key name.
Class S3Object Represents an S3 Object. Contains all attributes that an S3 Object has. For more information about S3 Objects refer: http://docs.amazonwebservices.com/AmazonS3/latest/UsingObjects.html
Class S3ObjectVersion Represents a version of an object in an S3 Bucket. An S3 object version is an S3 object that also has a version identifier, an indication of whether this is the latest version of the object and whether it's a DeleteMarker or not.
Class StreamResponse Base class for responses that return a stream.
Class StreamSizeMismatchException The exception that is thrown when the size of a stream does not match it's expected size.
Class Tag Tag
Class TopicConfiguration This class contains the configuration Amazon S3 uses to figure out what events you want to listen and send the event to an Amazon SNS topic.

The topic's policy must allow S3 to publish messages to it. The utility method Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient.AuthorizeS3ToPublish(System.String,System.String) can be used to help setup the topic policy.

Class TransferProgressArgs Arguments containing event details for an in-flight transfer.
Class UploadPartRequest The parameters to request upload of a part in a multipart upload operation.
Class UploadPartResponse Returns information about the UploadPart response and response metadata.
Class WebsiteConfiguration Website Configuration
Class WriteObjectProgressArgs Encapsulates the information needed to provide download progress for the Write Object Event.