AWS SDK for .NET Documentation
Amazon.S3.Model Namespace
AmazonAmazon.S3.Model Did this page help you?   Yes   No    Tell us about it...
 
Declaration Syntax
C#
namespace Amazon.S3.Model
Types
All TypesClassesEnumerations
IconTypeDescription
AbortMultipartUploadRequest
The parameters to request an abort of a multipart upload.

AbortMultipartUploadResponse
The AbortMultipartUploadResponse contains any headers returned by S3.

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

CompleteMultipartUploadRequest
The parameters to request completion of a multipart upload by assembling previously uploaded parts.

CompleteMultipartUploadResponse
The CompleteMultipartUploadResponse contains all the information about the CompleteMultipartUpload method.

CopyObjectRequest
The parameters to request a copy an existing S3 object to another, possibly new, S3 object. The source object may be copied to another object in the same or a different bucket.

CopyObjectResponse
The CopyObjectResponse contains all the information about the CopyObject operation.

CopyPartRequest
The parameters to upload a part by copying data from an existing object as data source.

CopyPartResponse
The CopyPartResponse contains all the information about the CopyPart operation.

CORSConfiguration
A collection of up to 100 cross-origin resource sharing (CORS) rules.

CORSRule
A set of origins and methods (cross-origin access that you want to allow).

DeleteBucketPolicyRequest
The parameters to request deletion of the policy on a bucket.

DeleteBucketPolicyResponse
The DeleteBucketPolicyResponse contains any headers returned by S3.

DeleteBucketRequest
The parameters to request deletion of a bucket.

DeleteBucketResponse
The DeleteBucketResponse contains any headers returned by S3.

DeleteBucketTaggingRequest
The parameters to request deletion of a tag set from a bucket.

DeleteBucketTaggingResponse
The DeleteBucketTaggingResponse contains any headers returned by S3.

DeleteBucketWebsiteRequest
The parameters to request removal of the website configuration for a bucket.

DeleteBucketWebsiteResponse
The DeleteBucketWebsiteResponse contains any headers returned by S3.

DeleteCORSConfigurationRequest
The parameters to request deletion of the cross origin resource sharing (CORS) configuration on a bucket.

DeleteCORSConfigurationResponse
The DeleteCORSConfigurationResponse contains any headers returned by S3.

DeletedObject
Contains information about a successful delete operation against a specific S3 object.

DeleteError
Contains information about a failed delete operation against a specific S3 object.

DeleteLifecycleConfigurationRequest
The parameters to request deletion of the lifecycle configuration on a bucket.

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

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.

DeleteObjectResponse
The DeleteObjectResponse contains any headers returned by S3.

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

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

DeleteObjectsRequest
The parameters to request deletion of one or more objects from a bucket.

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

DisableBucketLoggingRequest
The parameters to request logging be disabled on a bucket.

DisableBucketLoggingResponse
The DisableBucketLoggingResponse contains any headers returned by S3.

EnableBucketLoggingRequest
The parameters to request logging be enabled on a bucket.

EnableBucketLoggingResponse
The EnableBucketLoggingResponse contains any headers returned by S3.

EncodingType
A list of all encoding types.

Expiration
Defines the expiration policy for a given object.

GetACLRequest
The parameters to request the access control list (ACL) for a bucket or object.

GetACLResponse
The GetACLResponse contains all the information about the GetACL operation.

GetBucketLocationRequest
The parameters to request the region that contains a bucket.

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

GetBucketLoggingRequest
The parameters to request the logging status of a bucket.

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

GetBucketPolicyRequest
The parameters to request the policy set on a bucket.

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

GetBucketTaggingRequest
The parameters to request the tag set for a bucket.

GetBucketTaggingResponse
The DeleteBucketTaggingResponse contains the TagSets and any headers returned by S3.

GetBucketVersioningRequest
The parameters to request the versioning configuration for a bucket.

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

GetBucketWebsiteRequest
The parameters to request the website configuration settings for a bucket.

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

GetCORSConfigurationRequest
The parameters to request the cross origin resource sharing (CORS) configuration for a bucket.

GetCORSConfigurationResponse
The GetCORSConfigurationResponse contains the current CORSConfiguration for the bucket.

GetLifecycleConfigurationRequest
The parameters to request the lifecycle configuration settings for a bucket.

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

GetNotificationConfigurationRequest
The parameters to request the notification configuration settings for a bucket.

GetNotificationConfigurationResponse
The GetNotificationConfigurationResponse contains all the information about the GetNotificationConfiguration operation.

GetObjectMetadataRequest
The parameters to request metadata for an object.

GetObjectMetadataResponse
The GetObjectMetadataResponse contains any headers returned by S3.

GetObjectRequest
The parameters to fetch an object from a bucket.

GetObjectResponse
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.

GetPreSignedUrlRequest
The parameters to create a pre-signed URL to a bucket or object.

HttpVerb
An enumeration of supported HTTP verbs

InitiateMultipartUploadRequest
The parameters to start a multi-part upload to S3.

InitiateMultipartUploadResponse
The InitiateMultipartUploadResponse contains all the information about the InitiateMultipartUpload method.

KeyVersion
Specifies an object key and optional object version.

LifecycleConfiguration
A collection of expiration rules for an S3 bucket.

LifecycleRule
Values defining a lifecycle rule.

LifecycleRuleExpiration
Defines the length of time before objects expire

LifecycleRuleNoncurrentVersionExpiration
Noncurrent Version Expiration

LifecycleRuleNoncurrentVersionTransition
LifecycleTransition defines when and how objects transition.

LifecycleRuleStatus
An enumeration of all supported lifecycle rule statuses

LifecycleTransition
LifecycleTransition defines when and how objects transition.

ListBucketsRequest
The parameters to list the available buckets for the user.

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

ListMultipartUploadsRequest
The parameters to request a list of in-progress multipart uploads. An in-progress multipart upload is a multipart upload that has been initiated, using the Initiate Multipart Upload request, but has not yet been completed or aborted.

ListMultipartUploadsResponse
The ListMultipartUploadsResponse contains all the information about the ListMultipartUploads method.

ListObjectsRequest
The parameters to list the object keys in a bucket.

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

ListPartsRequest
The parameters to lists the parts that have been uploaded for a specific multipart upload.

ListPartsResponse
The ListPartsResponse contains all the information about the ListParts method.

ListVersionsRequest
The parameters to list object versions in a bucket.

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

MultipartUpload
Container for elements related to a particular multipart upload.

NotificationConfigurationList
The notification configuration for a bucket in S3.

NotificationEvents
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.

Owner
The owner of an S3 bucket.

PartDetail
A container for elements related to a particular part in a multipart operation. A response can contain zero or more Part elements.

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

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

PutBucketPolicyRequest
The parameters to set or update policy on a bucket.

PutBucketPolicyResponse
The PutBucketPolicyResponse contains any headers returned by S3.

PutBucketRequest
The parameters to request creation of a new bucket.

PutBucketResponse
The PutBucketResponse contains any headers returned by S3.

PutBucketTaggingRequest
The parameters to apply one or more tag sets to a bucket.

PutBucketTaggingResponse
The DeleteBucketTaggingResponse contains any headers returned by S3.

PutBucketWebsiteRequest
The parameters to set a website configuration on a bucket.

PutBucketWebsiteResponse
The PutBucketWebsiteResponse contains any headers returned by S3.

PutCORSConfigurationRequest
The parameters to set a cross origin resource sharing (CORS) configuration on a bucket.

PutCORSConfigurationResponse
The PutCORSConfigurationResponse contains any headers returned by S3.

PutLifecycleConfigurationRequest
The parameters to set a lifecycle configuration on a bucket.

PutLifecycleConfigurationResponse
The PutLifecycleConfigurationResponse contains any headers returned by S3.

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

PutObjectRequest
The parameters to add or update an object in a bucket.

PutObjectResponse
The PutObjectResponse contains any headers returned by S3.

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.

RestoreObjectRequest
RestoreObjectResponse
The RestoreObjectResponse contains any headers returned by S3.

RoutingRule
Container for one routing rule that identifies a condition and a redirect that applies when the condition is met.

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

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.

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.

S3Bucket
Represents an S3 bucket, contains the name of the S3 bucket and the date that the bucket was created.

S3BucketLoggingConfig
A configuration for S3 bucket logging operatons.

S3BucketVersioningConfig
An S3 bucket versioning configuration.

S3CannedACL
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

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

S3Grant

Represents a grant for a bucket or 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


S3Grantee

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


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

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

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.

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

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

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

S3Response
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.

S3StorageClass
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

ServerSideEncryptionCustomerMethod
A list of all server-side encryption methods for customer provided encryption keys.

ServerSideEncryptionMethod
The enumeration of all server-side encryption methods.

SetACLRequest
The parameters to set an access control list (ACL) on a bucket or S3 object. You can use either CannedACLs or provide an S3AccessControlList for custom ACLs.

SetACLResponse
The SetACLResponse contains any headers returned by S3.

SetBucketVersioningRequest
The parameters to control versioning on a bucket.

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

SetNotificationConfigurationRequest
The parameters used to configure notifications on a bucket. If the NotificationConfiguration is null or empty then the current configuration will be cleared.

SetNotificationConfigurationResponse
The PutBucketPolicyResponse contains any headers returned by S3.

Tag
A tag, consisting of a Key and Value

TagSet
A collection of tags

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

TransferProgressArgs
Arguments containing event details for an in-flight transfer.

Tuple<(Of <(<'T, U>)>)>
A key-value pair relating the key and value of type T and U respectively

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

UploadPartRequest
The parameters to request upload of a part in a multipart upload operation.

UploadPartResponse
The UploadPartResponse contains all the information about the UploadPart method.

WebsiteConfiguration
Defines the website configuration for a S3 bucket.

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