Types

The AbortMultipartUploadRequest contains the parameters used for the AbortMultipartUpload method.
Required Parameters: BucketName, Key, UploadId

The AbortMultipartUploadResponse contains any headers returned by S3.

IComparable class that is used when sorting a lit of grants.

The CompleteMultipartUploadRequest contains the parameters used for the CompleteMultipartUpload method.
Required Parameters: BucketName, Key, UploadId, PartETags

The CompleteMultipartUploadResponse contains all the information about the CompleteMultipartUpload method.

The CopyObjectRequest contains the parameters used for the CopyObject operation. For more information about the optional parameters, refer: http://docs.amazonwebservices.com/AmazonS3/latest/RESTObjectCOPY.html
Required Parameters: SourceBucket, SourceKey, DestinationBucket
Optional Parameters: DestinationKey, ETagToMatch, ETagToNotMatch, ModifiedSinceDate, UnmodifiedSinceDate, Directive, Metadata, CannedACL, Timeout, SourceVersionId, StorageClass

The CopyObjectResponse contains all the information about the CopyObject operation.

The CopyPartRequest contains the parameters used for the CopyPart operation.
Required Parameters: SourceBucket, SourceKey, DestinationBucket, DestinationKey, UploadID, PartNumber
Optional Parameters: ETagsToMatch, ETagsToNotMatch, ModifiedSinceDate, UnmodifiedSinceDate, Timeout, SourceVersionId, FirstByte, LastByte

The CopyPartResponse contains all the information about the CopyPart operation.

The DeleteBucketPolicyRequest contains the parameters used for the DeleteBucketPolicy operation.
Required Parameters: BucketName

The DeleteBucketPolicyResponse contains any headers returned by S3.

The DeleteBucketRequest contains the parameters used for the DeleteBucket operation.
Required Parameters: BucketName

The DeleteBucketResponse contains any headers returned by S3.

The DeleteBucketWebsiteRequest contains the parameters used for the DeleteBucketWebsiteRequest operation.
Required Parameters: BucketName

The DeleteBucketWebsiteResponse contains any headers returned by S3.

DeletedObject is a container for information about a successful delete operation against a specific S3 object.

DeleteError is a container for information about a failed delete operation against a specific S3 object.

The DeleteObjectsRequest contains the parameters used for the DeleteObjects operation.
Required Parameters: BucketName, Keys
The MfaCodes property is required if the bucket containing this object has been configured with the EnableMfaDelete property. For more information, please see: EnableMfaDelete.

The DeleteObjectsResponse contains a list of successful and failed deletes, as well as any headers returned by S3.

The DeleteObjectRequest contains the parameters used for the DeleteObject operation.
Required Parameters: BucketName, Key
The MfaCodes property is required if the bucket containing this object has been configured with the EnableMfaDelete property. For more information, please see: EnableMfaDelete.

The DeleteObjectResponse contains any headers returned by S3.

The DeleteObjectsResponse contains a list of successfu and failed deletes, as well as any headers returned by S3.

AmazonS3 exception. Thrown when DeleteObjects returns successfully, but some of the objects were not deleted.

The DeleteObjectsRequest contains the parameters used for the DeleteObjects operation.
Required Parameters: BucketName, Keys
The MfaCodes property is required if the bucket containing this object has been configured with the EnableMfaDelete property. For more information, please see: EnableMfaDelete.

The DeleteObjectsResponse contains a list of successful deletes, as well as any headers returned by S3.

The DisableBucketLoggingRequest contains the parameters used for the DisableBucketLogging operation.
Required Parameters: BucketName

The DisableBucketLoggingResponse contains any headers returned by S3.

The EnableBucketLoggingRequest contains the parameters used for the EnableBucketLogging operation.
Required Parameters: BucketName, LoggingConfig

The EnableBucketLoggingResponse contains any headers returned by S3.

Expiration defines the expiration policy for a given object

The GetACLRequest contains the parameters used for the GetACL operation. The BucketName is always required, the Key is optional and is to be set if you want the ACL for an object instead of a bucket.
Required Parameters: BucketName
Optional Parameters: Key, VersionId

The GetACLResponse contains all the information about the GetACL operation.

The GetBucketLocationRequest contains the parameters used for the GetBucketLocation operation.
Required Parameters: BucketName

The GetBucketLocationResponse contains the GetBucketLocationResult and any headers returned by S3.

The GetBucketLoggingRequest contains the parameters used for the GetBucketLogging operation.
Required Parameters: BucketName

The GetBucketLoggingResponse contains the GetBucketLoggingResult and any headers returned by S3.

The GetBucketPolicyRequest contains the parameters used for the GetBucketPolicy operation.
Required Parameters: BucketName

The GetBucketPolicyResponse contains the JSON string representation of the policy any headers returned by S3.

The GetBucketVersioningRequest contains the parameters used for the GetBucketVersioning operation.
Required Parameters: BucketName

The GetBucketVersioningResponse contains the GetBucketVersioningResult and any headers returned by S3.

The GetBucketWebsiteRequest contains the parameters used for the GetBucketWebsiteRequest operation.
Required Parameters: BucketName

The GetBucketWebsiteResponse contains the properties for S3 website configuration and any headers returned by S3.

The DeleteObjectsRequest contains the parameters used for the DeleteObjects operation.
Required Parameters: BucketName, Keys
The MfaCodes property is required if the bucket containing this object has been configured with the EnableMfaDelete property. For more information, please see: EnableMfaDelete.

The DeleteObjectsResponse contains a list of successful and failed deletes, as well as any headers returned by S3.

The GetNotificationConfigurationRequest contains the parameters used for the GetNotificationConfiguration operation.
Required Parameters: BucketName

The GetNotificationConfigurationResponse contains all the information about the GetNotificationConfiguration operation.

The GetObjectMetadataRequest contains the parameters used for the GetObjectMetadata operation. For more information about the optional parameters, refer: http://docs.amazonwebservices.com/AmazonS3/latest/RESTObjectGET.html
Required Parameters: BucketName, Key
Optional Parameters: ModifiedSinceDate, UnmodifiedSinceDate, ETagToMatch, ETagToNotMatch

The GetObjectMetadataResponse contains any headers returned by S3.

The GetObjectRequest contains the parameters used for the GetObject operation. For more information about the optional parameters, refer: http://docs.amazonwebservices.com/AmazonS3/latest/RESTObjectGET.html
Required Parameters: BucketName, Key
Optional Parameters: VersionId, ModifiedSinceDate, UnmodifiedSinceDate, ETagToMatch, ETagToNotMatch, ByteRange

The GetObjectResponse contains any header or metadata returned by S3. GetObjectResponse's contain resources that need to be disposed. The recommended way for handling GetObjectResponse objects is wrapping them in using clauses, like so:

CopyC#

using (GetObjectResponse response = s3Client.GetObject(request))
{
    ...
}

This will ensure that any network resources, file streams and web headers have been returned back to the system for future use.

The GetPreSignedUrlRequest contains the parameters used to create a pre signed URL. For more information, refer: http://docs.amazonwebservices.com/AmazonS3/latest/dev/S3_QSAuth.html
Required Parameters: BucketName, Expires
Optional Parameters: Key, VersionId, Verb: default is GET

An enumeration of supported HTTP verbs

The InitiateMultipartUploadRequest contains the parameters used for the InitiateMultipartUpload method.
Required Parameters: BucketName, Key

The InitiateMultipartUploadResponse contains all the information about the InitiateMultipartUpload method.

KeyVersion is a container for a key and optionally a version of an S3 object.

LifecycleConfiguration is a container for the collection of expiration rules for a specific S3 bucket.

LifecycleRule defines a lifecylce rule

LifecycleRuleExpiration defines the length of time before objects expire

An enumeration of all supported lifecycle rule statuses

The ListBucketsRequest contains the parameters used for the ListBuckets operation. No parameters are needed for this request.

The ListBucketsResponse contains the ListBucketsResult and any headers or metadata returned by S3.

The ListMultipartUploadsRequest contains the parameters used for the ListMultipartUploads method.
Required Parameters: BucketName

The ListMultipartUploadsResponse contains all the information about the ListMultipartUploads method.

The ListObjectsRequest contains the parameters used for the ListObjects operation.
Required Parameters: BucketName
Optional Parameters: Prefix, Marker, MaxKeys, Delimiter

The ListObjectsResponse contains the list of S3Objects in the bucket and any headers returned by S3.

The ListPartsRequest contains the parameters used for the ListParts method.
Required Parameters: BucketName, Key, UploadId

The ListPartsResponse contains all the information about the ListParts method.

The ListVersionsRequest contains the parameters used for the ListVersions operation.
Required Parameters: BucketName
Optional Parameters: Prefix, KeyMarker, VersionIdMarker, MaxKeys, Delimiter

The ListVersionsResponse contains the list of Versions in the bucket and any headers returned by S3.

Container for elements related to a particular multipart upload.

NotificationConfigurationList represents a notification configuration for a bucket in S3. A configuration is a collection of topic configurations which contain the event and topic arn. Currently only one event type is being supported with the possiblity of more event types in the future.

The constants for the known event names used by S3 notification. S3 might add new events before the SDK is updated. In which case the names listed in the S3 documentation will work as well as these constants.

Represents an Owner of an S3 Bucket.

PartDetails is a container for elements related to a particular part. A response can contain zero or more Part elements.

A container object for holding the part number and etag used when completing a multipart upload.

An enumeration of all protocols that the pre-signed URL can be created against.

The PutBucketPolicyRequest contains the parameters used for the PutBucketPolicy operation.
Required Parameters: BucketName, Policy

The PutBucketPolicyResponse contains any headers returned by S3.

The PutBucketRequest contains the parameters used for the PutBucket operation. The BucketRegion parameter is used if you wish to specify the bucket locality.
Required Parameters: BucketName
Optional Parameters: BucketRegion, Default - S3Region.US

The PutBucketResponse contains any headers returned by S3.

The PutBucketWebsiteRequest contains the parameters used for the PutBucketWebsiteRequest operation.
Required Parameters: BucketName, WebsiteConfiguration.IndexDocumentSuffix

The PutBucketWebsiteResponse contains any headers returned by S3.

The DeleteObjectsRequest contains the parameters used for the DeleteObjects operation.
Required Parameters: BucketName, Keys
The MfaCodes property is required if the bucket containing this object has been configured with the EnableMfaDelete property. For more information, please see: EnableMfaDelete.

The DeleteObjectsResponse contains a list of successful and failed deletes, as well as any headers returned by S3.

Encapsulates the information needed to provide transfer progress to subscribers of the Put Object Event.

The PutObjectRequest contains the parameters used for the PutObject operation.
Must set only 1 of ContentBody, InputStream, or FilePath
Required Parameters: BucketName, Key
Optional Parameters: CannedACL, ACL, MD5Digest, GenerateMD5Digest, ContentType, Metadata, Timeout

The PutObjectResponse contains any headers returned by S3.

This class contains the values of the response headers that will be set on the response from a GetObject request. These values override any headers that were set when the object was uploaded to S3.

AccessControlList represents an ACL for S3. An AccessControlList is represented by an Owner, and a List of Grants, where each Grant is a Grantee and a Permission.

Each bucket and object in Amazon S3 has an ACL that defines its access control policy. When a request is made, Amazon S3 authenticates the request using its standard authentication procedure and then checks the ACL to verify the sender was granted access to the bucket or object. If the sender is approved, the request proceeds. Otherwise, Amazon S3 returns an error.

An ACL is a list of grants. A grant consists of one grantee and one permission. ACLs only grant permissions; they do not deny them.

For convenience, some commonly used Access Control Lists are defined in S3CannedACL.

Note: Bucket and object ACLs are completely independent; an object does not inherit the ACL from its bucket. For example, if you create a bucket and grant write access to another user, you will not be able to access the user's objects unless the user explicitly grants access. This also applies if you grant anonymous write access to a bucket. Only the user "anonymous" will be able to access objects the user created unless permission is explicitly granted to the bucket owner.

Important: We highly recommend that you do not grant the anonymous group write access to your buckets as you will have no control over the objects others can store and their associated charges. For more information, see Grantees and Permissions

Represents an S3 Bucket. Contains a Bucket Name which is the name of the S3 Bucket. And a Creation Date which is the date that the S3 Bucket was created.

BucketLoggingConfig represents a configuration for the S3 bucket logging operatons. This includes a target bucket name which is where the logs will be stored, a target prefix which is the prefix assigned to all log files, and a List of grants which will set the AccessControl for the logs.

Represents an S3 Bucket Versioning Configuration. Contains the buckets VersioningStatus - Off, Enabled, Suspended. Whether an MFADelete has been enabled for the bucket.

An Enumeration of all possible CannedACLs that can be used for S3 Buckets or S3 Objects. For more information about CannedACLs, refer: http://docs.amazonwebservices.com/AmazonS3/latest/RESTAccessPolicy.html#RESTCannedAccessPolicies

Represents an error returned by the S3 service. Exposes an error code, a message, a host ID and a request ID for debugging purposes.

Represents a grant for an bucket/object ACL. A grant contains a S3Grantee and a S3Permission for that S3Grantee. For more information on Grants/ACLs refer: http://docs.amazonwebservices.com/AmazonS3/latest/index.html?RESTAuthentication.html

A S3Grantee represents an Owner/User/Group that can be given permissions on a bucket or object. For more information about Grantees or ACLs see: http://docs.amazonwebservices.com/AmazonS3/latest/index.html?RESTAuthentication.html

An enumeration of all Metadata directives that can be used for the CopyObject operation.

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

Represents an S3 Bucket Object Version. An S3 Object version is an S3 object that also has a VersionId, whether this is the Latest version of the object and if its a DeleteMarker or not.

An enumeration of all ACL permissions. For more information, refer: http://docs.amazonwebservices.com/AmazonS3/latest/S3_ACLs.html#S3_ACLs_Permissions

An enumeration of all possible S3 Bucket region possibilities. For more information, refer: http://docs.amazonwebservices.com/AmazonS3/latest/BucketConfiguration.html#LocationSelection

Base class for all S3 operation requests. Provides a header collection which can is used to store the request headers.

Base class for all S3 operation responses. Provides a header collection which is used to store the response headers. Also exposes the RequestId and AmazonId2 from S3 responses, as well as a Response Stream is the operation returned a stream. Lastly, if the response contained metadata, they are stored in the Metadata collection.

Specifies the Storage Class of of an S3 object. Possible values are:

• ReducedRedundancy: provides a 99.99% durability guarantee
• Standard: provides a 99.999999999% durability guarantee

The enumeration of all server-side encryption methods.

The SetACLRequest contains the parameters used for the SetACL operation. The BucketName is always required, the Key is optional and is to be set if you want the ACL for an object instead of a bucket. You can either set ACLs using CannedACLs or by providing an S3AccessControlList.
Required Parameters: BucketName
Optional Parameters: Key, CannedACL, ACL

The SetACLResponse contains any headers returned by S3.

The SetBucketVersioningRequest contains the parameters used for the SetBucketVersioning operation.
Required Parameters: BucketName, VersioningConfig
MfaCodes property is required if VersioningConfig.EnableMfaDelete = true

If you want to enable the use of a multi-factor authentication device on this bucket, please set the EnableMfaDelete property of VersioningConfig. If EnableMfaDelete is set to true, the MfaCodes property needs to be set with the Serial number and Current Token displayed on the MFA device.

The SetBucketVersioningResponse contains the headers and request specific information returned by S3

The SetNotificationConfigurationRequest contains the parameters used for the SetNotificationConfiguration operation. If the NotificationConfiguration is null or empty then the current configuration will be cleared.
Required Parameters: BucketName

The PutBucketPolicyResponse contains any headers returned by S3.

Represents a topic configuration for notification configuration. A topic configuration contains an event and a topic arn.

Creates a Key Value pair relating the key and value of type T and U respectively

Encapsulates the information needed to provide transfer progress to subscribers of the Put Object Event.

The UploadPartRequest contains the parameters used for the UploadPart method.

If PartSize is not specified then the rest of the content from the file or stream will be sent to Amazon S3.

You must set either the FilePath or InputStream. If FilePath is set then the FilePosition property must be set.

Required Parameters: BucketName, Key, UploadId, PartNumber

The UploadPartResponse contains all the information about the UploadPart method.

Properties that define the website configuration for a S3 bucket.

Encapsulates the information needed to provide download progress for the Write Object Event.