Table of Contents

Namespace Amazon.S3.Model

Classes

AbortMultipartUploadRequest

The parameters to request an abort of a multipart upload.

AbortMultipartUploadResponse

Returns information about the AbortMultipartUpload response metadata. The AbortMultipartUpload operation has a void result type.

AccelerateConfiguration

Bucket accelerate configuration.

AccessControlTranslation

AccessControlTranslation class

AnalyticsAndOperator

Class for AnalyticsAndOperator

A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. The operator must have at least two predicates, and an object must match all of the predicates in order for the filter to apply.

AnalyticsConfiguration

Class for AnalyticsConfiguration

AnalyticsExportDestination

Class for AnalyticsExportDestination

AnalyticsFilter

Filter class for Metrics.

AnalyticsFilterPredicate

Filter Predicate abstract class for specific filter types to be derived from.

AnalyticsNAryOperator

Abstract class that can be used over logical filter predicates,i.e. AND/OR.

AnalyticsPrefixPredicate

Class for AnalyticsPrefixPredicate

The prefix used when evaluating a metrics filter.

AnalyticsS3BucketDestination

Class for AnalyticsS3BucketDestination

AnalyticsTagPredicate

Class for MetricsTagPredicate

The tag used when evaluating a metrics filter.

ByteRange

This class represents the byte range for a range GET from S3.

CORSConfiguration

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

CORSRule

C O R S Rule

CSVInput

Describes how a CSV-formatted input object is formatted.

CSVOutput

Describes how CSV-formatted results are formatted.

CompleteMultipartUploadRequest

Container for the parameters to the CompleteMultipartUpload operation.

Completes a multipart upload by assembling previously uploaded parts.

CompleteMultipartUploadResponse

Returns information about the CompleteMultipartUpload response and response metadata.

ContinuationEvent

The Continuation Event.

CopyObjectRequest

Container for the parameters to the CopyObject operation.

Creates a copy of an object that is already stored in Amazon S3.

CopyObjectResponse

Returns information about the CopyObject response and response metadata.

CopyPartRequest

Container for the parameters to the CopyPart operation.

Uploads a part by copying data from an existing object as data source.

CopyPartResponse

Returns information about the CopyPart response and response metadata.

DefaultRetention

The container element for specifying the default Object Lock retention settings for new objects placed in the specified bucket.

DeleteBucketAnalyticsConfigurationRequest

Container for the parameters to the DeleteBucketAnalyticsConfiguration operation.

Deletes an analytics configuration for the bucket (specified by the analytics configuration ID).

DeleteBucketAnalyticsConfigurationResponse

Returns information about the DeleteBucketAnalyticsConfiguration response metadata. The DeleteBucketAnalyticsConfiguration operation has a void result type.

DeleteBucketEncryptionRequest

Request object for the DeleteBucketEncryption operation. Request Deletes the server-side encryption configuration from the bucket.

DeleteBucketEncryptionResponse

Returns information about the DeleteBucketEncryption response metadata. The DeleteBucketEncryption operation has a void result type.

DeleteBucketInventoryConfigurationRequest

Container for the parameters to the DeleteInventoryConfiguration operation.

Deletes an inventory configuration (identified by the inventory ID) from the bucket.

DeleteBucketInventoryConfigurationResponse

Returns information about the DeleteInventoryConfiguration response metadata. The DeleteInventoryConfiguration operation has a void result type.

DeleteBucketMetricsConfigurationRequest

Container for the parameters to the DeleteBucketMetricsConfiguration operation.

Deletes a metrics configuration (specified by the metrics configuration ID) from the bucket.

DeleteBucketMetricsConfigurationResponse

Returns information about the DeleteBucketMetricsConfiguration response metadata. The DeleteBucketMetricsConfiguration operation has a void result type.

DeleteBucketOwnershipControlsRequest

Container for the parameters to the DeleteBucketOwnershipControlsRequest operation.

DeleteBucketOwnershipControlsResponse

Returns information about the DeleteBucketOwnershipControls response metadata. The DeleteBucketOwnershipControls operation has a void result type.

DeleteBucketPolicyRequest

Container for the parameters to the DeleteBucketPolicy operation.

Deletes the policy from the bucket.

DeleteBucketPolicyResponse

Returns information about the DeleteBucketPolicy response metadata. The DeleteBucketPolicy operation has a void result type.

DeleteBucketReplicationRequest

Request object for the DeleteBucketReplication operation.

DeleteBucketReplicationResponse

Returns information about the DeleteBucketReplication response metadata. The DeleteBucketReplication operation has a void result type.

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.

DeleteBucketResponse

Returns information about the DeleteBucket response metadata. The DeleteBucket operation has a void result type.

DeleteBucketTaggingRequest

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

DeleteBucketTaggingResponse

Returns information about the DeleteBucketTagging response metadata. The DeleteBucketTagging operation has a void result type.

DeleteBucketWebsiteRequest

Container for the parameters to the DeleteBucketWebsite operation.

This operation removes the website configuration from the bucket.

DeleteBucketWebsiteResponse

Returns information about the DeleteBucketWebsite response metadata. The DeleteBucketWebsite operation has a void result type.

DeleteCORSConfigurationRequest

Container for the parameters to the DeleteCORSConfiguration operation.

Deletes the cors configuration information set for the bucket.

DeleteCORSConfigurationResponse

Returns information about the DeleteCORSConfiguration response metadata. The DeleteCORSConfiguration operation has a void result type.

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

Returns information about the DeleteLifecycleConfiguration response metadata. The DeleteLifecycleConfiguration operation has a void result type.

DeleteMarkerReplication

Specifies whether Amazon S3 should replicate delete makers.

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

Returns information about the DeleteObject response and response metadata.

DeleteObjectTaggingRequest

Container for the parameters to the DeleteObjectTaggingRequest operation.

DeleteObjectTaggingResponse

Returns information about the DeleteObjectTagging response and response metadata.

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.

DeleteObjectsResponse

Returns information about the DeleteObjects response and response metadata.

DeletePublicAccessBlockRequest

Container for the parameters to the DeletePublicAccessBlock operation. Removes the Public Access Block configuration for an Amazon S3 bucket.

DeletePublicAccessBlockResponse

This is the response object from the DeletePublicAccessBlock operation.

DeletedObject

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

EncryptionConfiguration

EncryptionConfiguration class

EndEvent

The End Event.

ExistingObjectReplication

A container that specifies information about existing object replication. You can choose whether to enable or disable the replication of existing objects.

Expiration

Defines the expiration policy for a given object.

Filter

Bucket Represents a set of filter criteria that limits the objects that can trigger event notifications

FilterRule

Bucket Represents a Filter Rule for a NotificationConfiguration.

GetACLRequest

Container for the parameters to the GetACL operation.

Returns the access control list (ACL) of an object.

GetACLResponse

Returns information about the GetACL response and response metadata.

GetBucketAccelerateConfigurationRequest

Container for the parameters to the GetBucketAccelerateConfiguration operation.

GetBucketAccelerateConfigurationResponse

The response class for GetBucketAccelerateConfiguration operation.

GetBucketAnalyticsConfigurationRequest

Container for the parameters to the GetBucketAnalyticsConfiguration operation.

Gets an analytics configuration for the bucket (specified by the analytics configuration ID).

GetBucketAnalyticsConfigurationResponse

GetBucketAnalyticsConfigurationResponse Response

GetBucketEncryptionRequest

Container for the parameters to the GetBucketEncryptionRequest operation.

Returns the server-side encryption configuration of a bucket.

GetBucketEncryptionResponse

GetBucketEncryptionResponse Response

GetBucketInventoryConfigurationRequest

Container for the parameters to the GetInventoryConfigurationRequest operation.

Returns an inventory configuration (identified by the inventory ID) from the bucket.

GetBucketInventoryConfigurationResponse

GetInventoryConfigurationResponse Response

GetBucketLocationRequest

Container for the parameters to the GetBucketLocation operation.

Returns the region the bucket resides in.

GetBucketLocationResponse

Returns information about the GetBucketLocation response and response metadata.

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.

GetBucketLoggingResponse

Returns information about the GetBucketLogging response and response metadata.

GetBucketMetricsConfigurationRequest

Container for the parameters to the GetBucketMetricsConfiguration operation.

Gets a metrics configuration (specified by the metrics configuration ID) from the bucket.

GetBucketMetricsConfigurationResponse

GetBucketMetricsConfiguration Response

GetBucketNotificationRequest

Container for the parameters to the GetBucketNotification operation.

Return the notification configuration of a bucket.

GetBucketNotificationResponse

Returns information about the GetBucketNotification response and response metadata.

GetBucketOwnershipControlsRequest

Container for the parameters to the GetBucketOwnershipControls operation.

GetBucketOwnershipControlsResponse

Returns information about the GetBucketOwnershipControls response and response metadata.

GetBucketPolicyRequest

Container for the parameters to the GetBucketPolicy operation.

Returns the policy of a specified bucket.

GetBucketPolicyResponse

Get BucketName Policy Response

GetBucketPolicyStatusRequest

Container for the parameters to the GetBucketPolicyStatus operation. Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket is public.

GetBucketPolicyStatusResponse

This is the response object from the GetBucketPolicyStatus operation.

GetBucketReplicationRequest

Container for the parameters to the GetBucketReplicationConfiguration operation.

Returns the replication configuration information set on the bucket.

GetBucketReplicationResponse

Returns information about the GetReplicationConfiguration response and response metadata.

GetBucketRequestPaymentRequest

Container for the parameters to the GetBucketRequestPayment operation.

Returns the request payment configuration of a bucket.

GetBucketRequestPaymentResponse

Returns information about the GetBucketRequestPayment response and response metadata.

GetBucketTaggingRequest

Container for the parameters to the GetBucketTagging operation.

Returns the tag set associated with the bucket.

GetBucketTaggingResponse

Returns information about the GetBucketTagging response and response metadata.

GetBucketVersioningRequest

Container for the parameters to the GetBucketVersioning operation.

Returns the versioning state of a bucket.

GetBucketVersioningResponse

Returns information about the GetBucketVersioning response and response metadata.

GetBucketWebsiteRequest

Container for the parameters to the GetBucketWebsite operation.

Returns the website configuration for a bucket.

GetBucketWebsiteResponse

Returns information about the GetBucketWebsite response and response metadata.

GetCORSConfigurationRequest

Container for the parameters to the GetBucketCors operation.

Returns the cors configuration for the bucket.

GetCORSConfigurationResponse

Returns information about the GetBucketCors response and response metadata.

GetLifecycleConfigurationRequest

Container for the parameters to the GetLifecycleConfiguration operation.

Returns the lifecycle configuration information set on the bucket.

GetLifecycleConfigurationResponse

Returns information about the GetLifecycleConfiguration response and response metadata.

GetObjectLegalHoldRequest

Container for the parameters to the GetObjectLegalHold operation. Gets an object's current Legal Hold status.

GetObjectLegalHoldResponse

This is the response object from the GetObjectLegalHold operation.

GetObjectLockConfigurationRequest

Container for the parameters to the GetObjectLockConfiguration operation. Gets the Object Lock configuration for a bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket.

GetObjectLockConfigurationResponse

This is the response object from the GetObjectLockConfiguration operation.

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.

GetObjectMetadataResponse

Returns information about the HeadObject response and response metadata.

GetObjectRequest

Container for the parameters to the GetObject operation.

Retrieves objects from Amazon S3.

GetObjectResponse

Returns information about the GetObject response and response metadata.

GetObjectRetentionRequest

Container for the parameters to the GetObjectRetention operation. Retrieves an object's retention settings.

GetObjectRetentionResponse

This is the response object from the GetObjectRetention operation.

GetObjectTaggingRequest

Container for the parameters to the GetObjectTaggingRequest operation.

GetObjectTaggingResponse

Returns information about the GetObjectTagging response and response metadata.

GetObjectTorrentRequest

Container for the parameters to the GetObjectTorrent operation.

Return torrent files from a bucket.

GetObjectTorrentResponse

Returns information about the GetObjectTorrent response and response metadata.

GetPreSignedUrlRequest

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

GetPreSignedUrlResponse

The parameters for a pre-signed URL to a bucket or object as a string.

GetPublicAccessBlockRequest

Container for the parameters to the GetPublicAccessBlock operation. Retrieves the Public Access Block configuration for an Amazon S3 bucket.

GetPublicAccessBlockResponse

This is the response object from the GetPublicAccessBlock operation.

HeadersCollection

This class contains the headers for an S3 object.

InitiateMultipartUploadRequest

Container for the parameters to the InitiateMultipartUpload operation.

Initiates a multipart upload and returns an upload ID.

InitiateMultipartUploadResponse

Returns information about the InitiateMultipartUpload response and response metadata.

Initiator

Identifies who initiated the multipart upload.

InputSerialization

Describes the serialization format of the object.

InventoryConfiguration

Class for MetricsConfiguration

InventoryDestination

Class for InventoryDestination

InventoryEncryption

InventoryEncryption class

InventoryFilter

Class for InventoryFilter

InventoryFilterPredicate

Filter Predicate abstract class for specific filter types to be derived from.

InventoryPrefixPredicate

Class for InventoryPrefixPredicate

The prefix that an object must have to be included in the inventory results.

InventoryS3BucketDestination
InventorySchedule

Class for InventorySchedule

JSONInput

Specifies JSON as object's input serialization format.

JSONOutput

Specifies JSON as request's output serialization format

KeyVersion

Specifies an object key and optional object version.

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.

LifecycleAndOperator

The logical and operator for filtering objects for a LifecycleRule

LifecycleConfiguration

Lifecycle Configuration

LifecycleFilter

Filter identifying one or more objects to which a LifecycleRule applies.

LifecycleFilterPredicate

Base class for all the different predicates that can be used in a LifecycleRule filter.

LifecycleNAryOperator

Base class for lifecycle operators.

LifecyclePrefixPredicate

A predicate that filters objects for a LifecycleRule by matching a particular prefix.

LifecycleRule

Rules Item

LifecycleRuleAbortIncompleteMultipartUpload

Specifies the days since the initiation of an Incomplete Multipart Upload that Lifecycle will wait before permanently removing all parts of the upload.

LifecycleRuleExpiration

Expiration

LifecycleRuleNoncurrentVersionExpiration

Noncurrent Version Expiration

LifecycleRuleNoncurrentVersionTransition

LifecycleTransition defines when and how objects transition.

LifecycleTagPredicate

A predicate that filters objects for a LifecycleRule by matching a particular Tag key and value.

LifecycleTransition

LifecycleTransition defines when and how objects transition.

ListBucketAnalyticsConfigurationsRequest

Container for the parameters to the ListInventoryConfigurationsRequest operation.

Lists the analytics configurations for the bucket.

ListBucketAnalyticsConfigurationsResponse

Returns information about the ListBucketAnalyticsConfigurationsResponse response and response metadata.

ListBucketInventoryConfigurationsRequest

Container for the parameters to the ListInventoryConfigurationsRequest operation.

Returns a list of inventory configurations for the bucket.

ListBucketInventoryConfigurationsResponse

Returns information about the ListInventoryConfigurationsResponse response and response metadata.

ListBucketMetricsConfigurationsRequest

Container for the parameters to the ListBucketMetricsConfigurationRequest operation.

Lists the metrics configurations for the bucket.

ListBucketMetricsConfigurationsResponse

Returns information about the ListBucketMetricsConfiguration response and response metadata.

ListBucketsRequest

Container for the parameters to the ListBuckets operation.

Returns a list of all buckets owned by the authenticated sender of the request.

ListBucketsResponse

Returns information about the ListBuckets response and response metadata.

ListMultipartUploadsRequest

Container for the parameters to the ListMultipartUploads operation.

This operation lists in-progress multipart uploads.

ListMultipartUploadsResponse

Returns information about the ListMultipartUploads response and response metadata.

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.

ListObjectsResponse

Returns information about the ListObjects response and response metadata.

ListObjectsV2Request

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.

ListObjectsV2Response

Returns information about the ListObjects response and response metadata.

ListPartsRequest

Container for the parameters to the ListParts operation.

Lists the parts that have been uploaded for a specific multipart upload.

ListPartsResponse

Returns information about the ListParts response and response metadata.

ListVersionsRequest

Container for the parameters to the ListVersions operation.

Returns metadata about all of the versions of objects in a bucket.

ListVersionsResponse

Returns information about the ListVersions response and response metadata.

MetadataCollection

This class contains the meta data for an S3 object.

MetadataEntry

A metadata key-value pair to store with an object.

Metrics

A container specifying replication metrics-related information, including whether emitting metrics and Amazon S3 events for replication are enabled. In addition, contains configurations related to specific metrics or events. Must be specified together with a

ReplicationTime
block.
MetricsAndOperator

Class for MetricsAndOperatorPredicate

A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. The operator must have at least two predicates, and an object must match all of the predicates in order for the filter to apply.

MetricsConfiguration

Class for MetricsConfiguration

MetricsFilter

Filter class for Metrics.

MetricsFilterPredicate

Filter Predicate abstract class for specific filter types to be derived from.

MetricsNAryOperator

Abstract class that can be used over logical filter predicates,i.e. AND/OR.

MetricsPrefixPredicate

Class for MetricsPrefixPredicate

The prefix used when evaluating a metrics filter.

MetricsTagPredicate

Class for MetricsTagPredicate

The tag used when evaluating a metrics filter.

MfaCodes

This class contains the mfa codes used authentication

MultipartUpload

Container for elements related to a particular multipart upload.

NotificationConfiguration

An abstract class for all the notification configurations associated with an Amazon S3 bucket.

ObjectLockConfiguration

The container element for Object Lock configuration parameters.

ObjectLockLegalHold

A Legal Hold configuration for an object.

ObjectLockRetention

A Retention configuration for an object.

ObjectLockRule

The container element for an Object Lock rule.

OutputLocation

Describes the location where the restore job's output is stored.

OutputSerialization

Describes how results of the Select job are serialized.

Owner

The owner of an S3 bucket.

OwnershipControls

The container element for a bucket's ownership controls

OwnershipControlsRule

The container element for an ownership control rule

ParameterCollection

This class contains custom querystring parameters for an S3 object, which can then be signed as part of a Pre-signed URL request

ParquetInput

Specifies Parquet as object's input serialization format.

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.

PolicyStatus

The container element for this bucket's public-policy status.

Progress

The Progress event details.

ProgressEvent

The Progress Event.

PublicAccessBlockConfiguration

The container element for all Public Access Block configuration options. You can enable the configuration options in any combination.

Amazon S3 considers a bucket policy public unless at least one of the following conditions is true:

  1. The policy limits access to a set of CIDRs using

    aws:SourceIp
    . For more information on CIDR, see http://www.rfc-editor.org/rfc/rfc4632.txt
  2. The policy grants permissions, not including any "bad actions," to one of the following:

    • A fixed AWS principal, user, role, or service principal

    • A fixed

      aws:SourceArn
    • A fixed

      aws:SourceVpc
    • A fixed

      aws:SourceVpce
    • A fixed

      aws:SourceOwner
    • A fixed

      aws:SourceAccount
    • A fixed value of

      s3:x-amz-server-side-encryption-aws-kms-key-id
    • A fixed value of

      aws:userid
      outside the pattern "
      AROLEID:*
      "

"Bad actions" are those that could expose the data inside a bucket to reads or writes by the public. These actions are

s3:Get*
,
s3:List*
,
s3:AbortMultipartUpload
,
s3:Delete*
,
s3:Put*
, and
s3:RestoreObject
.

The star notation for bad actions indicates that all matching operations are considered bad actions. For example, because

s3:Get*
is a bad action,
s3:GetObject
,
s3:GetObjectVersion
, and
s3:GetObjectAcl
are all bad actions.
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

PutACLResponse

Returns information about the PutObjectAcl response metadata. The PutAcl operation has a void result type.

PutBucketAccelerateConfigurationRequest

Container for the parameters to the PutBucketAccelerateConfiguration request.

PutBucketAccelerateConfigurationResponse

The response for the PutBucketAccelerateConfiguration operation.

Adds an object to a bucket.

PutBucketAnalyticsConfigurationRequest

Container for the parameters to the PutBucketAnalyticsConfiguration operation.

Sets an analytics configuration for the bucket (specified by the analytics configuration ID).

PutBucketAnalyticsConfigurationResponse

Returns information about the PutBucketAnalyticsConfigurationResponse response metadata. The PutBucketAnalyticsConfigurationResponse operation has a void result type.

PutBucketEncryptionRequest

Container for the parameters to the PutBucketRequestPayment operation.

Creates a new server-side encryption configuration (or replaces an existing one, if present).

PutBucketInventoryConfigurationRequest

Container for the parameters to the PutBucketRequestPayment operation.

Adds an inventory configuration (identified by the inventory ID) from the bucket.

PutBucketInventoryConfigurationResponse

Returns information about the PutInventoryConfigurationResponse response metadata. The PutInventoryConfigurationResponse operation has a void result type.

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.

PutBucketLoggingResponse

Returns information about the PutBucketLogging response metadata. The EnableBucketLogging operation has a void result type.

PutBucketMetricsConfigurationRequest

Container for the parameters to the PutBucketMetricsConfigurationRequest operation.

Sets a metrics configuration (specified by the metrics configuration ID) for the bucket.

PutBucketMetricsConfigurationResponse

Returns information about the PutBucketMetricsConfiguration response metadata. The PutBucketMetricsConfiguration operation has a void result type.

PutBucketNotificationRequest

Container for the parameters to the PutBucketNotification operation.

Enables notifications of specified events for a bucket.

PutBucketNotificationResponse

Returns information about the PutBucketNotification response metadata. The PutBucketNotification operation has a void result type.

PutBucketOwnershipControlsRequest

Container for the parameters to the PutBucketOwnershipControls operation.

PutBucketOwnershipControlsResponse

Returns information about the PutBucketOwnershipControls response metadata. The PutBucketOwnershipControls operation has a void result type.

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.

PutBucketPolicyResponse

Returns information about the PutBucketPolicy response metadata. The PutBucketPolicy operation has a void result type.

PutBucketReplicationRequest

Container for the parameters to the PutBucketReplication operation.

Sets replication configuration for your bucket. If a replication configuration exists, this replaces it.

PutBucketReplicationResponse

Returns information about the PutBucketReplicationConfiguration response metadata. The PutBucketReplicationConfiguration operation has a void result type.

PutBucketRequest

Container for the parameters to the PutBucket operation.

Creates a new bucket.

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.

PutBucketRequestPaymentResponse

Returns information about the PutBucketRequestPayment response metadata. The PutBucketRequestPayment operation has a void result type.

PutBucketResponse

Returns information about the PutBucket response and response metadata.

PutBucketTaggingRequest

Container for the parameters to the PutBucketTagging operation.

Sets the tags for a bucket.

PutBucketTaggingResponse

Returns information about the PutBucketTagging response metadata. The PutBucketTagging operation has a void result type.

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.

PutBucketVersioningResponse

Returns information about the PutBucketVersioning response metadata. The PutBucketVersioning operation has a void result type.

PutBucketWebsiteRequest

Container for the parameters to the PutBucketWebsite operation.

Set the website configuration for a bucket.

PutBucketWebsiteResponse

Returns information about the PutBucketWebsite response metadata. The PutBucketWebsite operation has a void result type.

PutCORSConfigurationRequest

Container for the parameters to the PutCORSConfiguration operation.

Sets the cors configuration for a bucket.

PutCORSConfigurationResponse

Returns information about the PutCORSConfiguration response metadata. The PutCORSConfiguration operation has a void result type.

PutLifecycleConfigurationRequest

Container for the parameters to the PutLifecycleConfiguration operation.

Sets lifecycle configuration for your bucket. If a lifecycle configuration exists, it replaces it.

PutLifecycleConfigurationResponse

Returns information about the PutLifecycleConfiguration response metadata. The PutLifecycleConfiguration operation has a void result type.

PutObjectLegalHoldRequest

Container for the parameters to the PutObjectLegalHold operation. Applies a Legal Hold configuration to the specified object.

PutObjectLegalHoldResponse

This is the response object from the PutObjectLegalHold operation.

PutObjectLockConfigurationRequest

Container for the parameters to the PutObjectLockConfiguration operation. Places an Object Lock configuration on the specified bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket.

PutObjectLockConfigurationResponse

This is the response object from the PutObjectLockConfiguration operation.

PutObjectRequest

Container for the parameters to the PutObject operation.

Adds an object to a bucket.

PutObjectResponse

Returns information about the PutObject response and response metadata.

PutObjectRetentionRequest

Container for the parameters to the PutObjectRetention operation. Places an Object Retention configuration on an object.

PutObjectRetentionResponse

This is the response object from the PutObjectRetention operation.

PutObjectTaggingRequest

Container for the parameters to the PutObjectTagging operation.

PutObjectTaggingResponse

Returns information about the PutObjectTagging response and response metadata.

PutPublicAccessBlockRequest

Container for the parameters to the PutPublicAccessBlock operation. Creates or modifies the Public Access Block configuration for an Amazon S3 bucket.

PutPublicAccessBlockResponse

This is the response object from the PutPublicAccessBlock operation.

PutWithACLRequest

Base class for put operations that can also put an ACL.

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(string,string) can be used to help setup the queue policy.

RecordsEvent

The Records Event

ReplicationConfiguration

This class defines the configuration for replication.

ReplicationDestination

Destination configuration for a replication rule.

ReplicationRule

Rule that specifies the replication configuration.

ReplicationRuleAndOperator
ReplicationRuleFilter

Filter that identifies subset of objects to which the replication rule applies. A

Filter
must specify exactly one
Prefix
,
Tag
, or an
And
child element.
ReplicationTime

A container specifying the time when all objects and operations on objects are replicated. Must be specified together with a

Metrics
block.
ReplicationTimeValue

A container specifying the time value.

RequestPaymentConfiguration

Request Payment Configuration

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

Container for the parameters to the RestoreObject operation.

Restores an archived copy of an object back into Amazon S3

RestoreObjectResponse

Returns information about the RestoreObject response metadata. The RestoreObject operation has a void result type.

RoutingRule

Routing Rule

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.

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

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

S3BucketLoggingConfig

Logging Enabled

S3BucketVersioningConfig

An S3 bucket versioning configuration.

S3Encryption

Describes the server-side encryption that will be applied to the restore results.

S3EventStreamException

Modeled Exception that either comes over the stream from the service model, or wraps other exceptions for the purpose of raising events. If it is modelled, it will be a subclass.

S3Grant

Grant

S3Grantee

Grantee

S3KeyFilter

Filter criteria that allows for event notification filtering based on an S3 Object's key name.

S3Location

Describes an S3 location that will receive the results of the restore request.

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.

S3PaginatorFactory

Paginators for the S3 service

SSEKMS

SSEKMS class

SSES3

SSES3 class

ScanRange

Specifies the byte range of the object to get the records from. A record is processed when its first byte is contained by the range.

SelectObjectContentEventStream

A Stream of Events returned by the SelectObjectContent operation. Events can be retrieved from this stream by either

  • attaching handlers to listen events, and then call StartProcessing or
  • enumerating over the events.

These options should be treaded as mutually exclusive.
SelectObjectContentRequest

Request to filter the contents of an Amazon S3 object based on a simple Structured Query Language (SQL) statement.

In the request, along with the SQL expression, you must also specify a data serialization format (JSON or CSV) of the object. Amazon S3 uses this to parse object data into records, and returns only records that match the specified SQL expression. You must also specify the data serialization format for the response.

SelectObjectContentResponse

Contains the response Payload for the SelectObjectContent request

SelectParameters

Describes the parameters for Select job types.

ServerSideEncryptionByDefault

ServerSideEncryptionByDefault class

ServerSideEncryptionConfiguration

ServerSideEncryptionConfiguration class

ServerSideEncryptionRule

ServerSideEncryptionRule class

SourceSelectionCriteria

SourceSelectionCriteria class

SseKmsEncryptedObjects

SseKmsEncryptedObjects class

Stats

The Stats event details.

StatsEvent

The Stats Event.

StorageClassAnalysis

Class for StorageClassAnalysis

StorageClassAnalysisDataExport

Class for StorageClassAnalysisDataExport

StreamResponse

Base class for responses that return a stream.

StreamSizeMismatchException

The exception that is thrown when the size of a stream does not match it's expected size.

Tag

Tag is a key-value pair of metadata associated with an S3Object

Tagging

Structure that contains list of Tags

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(string,string) can be used to help setup the topic policy.

TransferProgressArgs

Arguments containing event details for an in-flight transfer.

UnknownEventStreamEvent

This Event is returned if an event is retrieved from the event stream, but a generator function for the event is not defined.

UploadPartRequest

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

UploadPartResponse

Returns information about the UploadPart response and response metadata.

WebsiteConfiguration

Website Configuration

WriteObjectProgressArgs

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

Interfaces

IListMultipartUploadsPaginator

Paginator for the ListMultipartUploads operation

IListObjectsPaginator

Paginator for the ListObjects operation

IListObjectsV2Paginator

Paginator for the ListObjectsV2 operation

IListPartsPaginator

Paginator for the ListParts operation

IListVersionsPaginator

Paginator for the ListVersions operation

IS3Event

Common Contract for S3 Events.

IS3PaginatorFactory

Paginators for the S3 service

ISelectObjectContentEventStream

The contract for the SelectObjectContentEventStream.