Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

Usage

import * as mod from "https://aws-api.deno.dev/v0.4/services/s3.ts?docs=full";

§Classes

S3

§Interfaces

_Object

An object consists of data and its descriptive metadata.

AbortIncompleteMultipartUpload

Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 will wait before permanently removing all parts of the upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy in the Amazon S3 User Guide.

AbortMultipartUploadOutput
AbortMultipartUploadRequest
AccelerateConfiguration

Configures the transfer acceleration state for an Amazon S3 bucket. For more information, see Amazon S3 Transfer Acceleration in the Amazon S3 User Guide.

AccessControlPolicy

Contains the elements that set the ACL permissions for an object per grantee.

AccessControlTranslation

A container for information about access control for replicas.

AnalyticsAndOperator

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

AnalyticsConfiguration

Specifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket.

AnalyticsExportDestination

Where to publish the analytics results.

AnalyticsFilter

The filter used to describe a set of objects for analyses. A filter must have exactly one prefix, one tag, or one conjunction (AnalyticsAndOperator). If no filter is provided, all objects will be considered in any analysis.

AnalyticsS3BucketDestination

Contains information about where to publish the analytics results.

Bucket

In terms of implementation, a Bucket is a resource. An Amazon S3 bucket name is globally unique, and the namespace is shared by all Amazon Web Services accounts.

BucketLifecycleConfiguration

Specifies the lifecycle configuration for objects in an Amazon S3 bucket. For more information, see Object Lifecycle Management in the Amazon S3 User Guide.

BucketLoggingStatus

Container for logging status information.

Checksum

Contains all the possible checksum or digest values for an object.

CloudFunctionConfiguration

Container for specifying the Lambda notification configuration.

CommonPrefix

Container for all (if there are any) keys between Prefix and the next occurrence of the string specified by a delimiter. CommonPrefixes lists keys that act like subdirectories in the directory specified by Prefix. For example, if the prefix is notes/ and the delimiter is a slash (/) as in notes/summer/july, the common prefix is notes/summer/.

CompletedMultipartUpload

The container for the completed multipart upload details.

CompletedPart

Details of the parts that were uploaded.

CompleteMultipartUploadOutput
CompleteMultipartUploadRequest
Condition

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.

ContinuationEvent
CopyObjectOutput
CopyObjectRequest
CopyObjectResult

Container for all response elements.

CopyPartResult

Container for all response elements.

CORSConfiguration

Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more information, see Enabling Cross-Origin Resource Sharing in the Amazon S3 User Guide.

CORSRule

Specifies a cross-origin access rule for an Amazon S3 bucket.

CreateBucketConfiguration

The configuration information for the bucket.

CreateBucketOutput
CreateBucketRequest
CreateMultipartUploadOutput
CreateMultipartUploadRequest
CSVInput

Describes how an uncompressed comma-separated values (CSV)-formatted input object is formatted.

CSVOutput

Describes how uncompressed comma-separated values (CSV)-formatted results are formatted.

DefaultRetention

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

Delete

Container for the objects to delete.

DeleteBucketAnalyticsConfigurationRequest
DeleteBucketCorsRequest
DeleteBucketEncryptionRequest
DeleteBucketIntelligentTieringConfigurationRequest
DeleteBucketInventoryConfigurationRequest
DeleteBucketLifecycleRequest
DeleteBucketMetricsConfigurationRequest
DeleteBucketOwnershipControlsRequest
DeleteBucketPolicyRequest
DeleteBucketReplicationRequest
DeleteBucketRequest
DeleteBucketTaggingRequest
DeleteBucketWebsiteRequest
DeletedObject

Information about the deleted object.

DeleteMarkerEntry

Information about the delete marker.

DeleteMarkerReplication

Specifies whether Amazon S3 replicates delete markers. If you specify a Filter in your replication configuration, you must also include a DeleteMarkerReplication element. If your Filter includes a Tag element, the DeleteMarkerReplication Status must be set to Disabled, because Amazon S3 does not support replicating delete markers for tag-based rules. For an example configuration, see Basic Rule Configuration.

DeleteObjectOutput
DeleteObjectRequest
DeleteObjectsOutput
DeleteObjectsRequest
DeleteObjectTaggingOutput
DeleteObjectTaggingRequest
DeletePublicAccessBlockRequest
Destination

Specifies information about where to publish analysis or configuration results for an Amazon S3 bucket and S3 Replication Time Control (S3 RTC).

Encryption

Contains the type of server-side encryption used.

EncryptionConfiguration

Specifies encryption-related information for an Amazon S3 bucket that is a destination for replicated objects.

EndEvent

A message that indicates the request is complete and no more messages will be sent. You should not assume that the request is complete until the client receives an EndEvent.

Error

Container for all error elements.

ErrorDocument

The error information.

EventBridgeConfiguration

A container for specifying the configuration for Amazon EventBridge.

ExistingObjectReplication

Optional configuration to replicate existing source bucket objects. For more information, see Replicating Existing Objects in the Amazon S3 User Guide.

FilterRule

Specifies the Amazon S3 object key name to filter on and whether to filter on the suffix or prefix of the key name.

GetBucketAccelerateConfigurationOutput
GetBucketAccelerateConfigurationRequest
GetBucketAclOutput
GetBucketAclRequest
GetBucketAnalyticsConfigurationOutput
GetBucketAnalyticsConfigurationRequest
GetBucketCorsOutput
GetBucketCorsRequest
GetBucketEncryptionOutput
GetBucketEncryptionRequest
GetBucketIntelligentTieringConfigurationOutput
GetBucketIntelligentTieringConfigurationRequest
GetBucketInventoryConfigurationOutput
GetBucketInventoryConfigurationRequest
GetBucketLifecycleConfigurationOutput
GetBucketLifecycleConfigurationRequest
GetBucketLifecycleOutput
GetBucketLifecycleRequest
GetBucketLocationOutput
GetBucketLocationRequest
GetBucketLoggingOutput
GetBucketLoggingRequest
GetBucketMetricsConfigurationOutput
GetBucketMetricsConfigurationRequest
GetBucketNotificationConfigurationRequest
GetBucketOwnershipControlsOutput
GetBucketOwnershipControlsRequest
GetBucketPolicyOutput
GetBucketPolicyRequest
GetBucketPolicyStatusOutput
GetBucketPolicyStatusRequest
GetBucketReplicationOutput
GetBucketReplicationRequest
GetBucketRequestPaymentOutput
GetBucketRequestPaymentRequest
GetBucketTaggingOutput
GetBucketTaggingRequest
GetBucketVersioningOutput
GetBucketVersioningRequest
GetBucketWebsiteOutput
GetBucketWebsiteRequest
GetObjectAclOutput
GetObjectAclRequest
GetObjectAttributesOutput
GetObjectAttributesParts

A collection of parts associated with a multipart upload.

GetObjectAttributesRequest
GetObjectLegalHoldOutput
GetObjectLegalHoldRequest
GetObjectLockConfigurationOutput
GetObjectLockConfigurationRequest
GetObjectOutput
GetObjectRequest
GetObjectRetentionOutput
GetObjectRetentionRequest
GetObjectTaggingOutput
GetObjectTaggingRequest
GetObjectTorrentOutput
GetObjectTorrentRequest
GetPublicAccessBlockOutput
GetPublicAccessBlockRequest
GlacierJobParameters

Container for S3 Glacier job parameters.

Grant

Container for grant information.

Grantee

Container for the person being granted permissions.

HeadBucketRequest
HeadObjectOutput
HeadObjectRequest
IndexDocument

Container for the Suffix element.

Initiator

Container element that identifies who initiated the multipart upload.

InputSerialization

Describes the serialization format of the object.

IntelligentTieringAndOperator

A container for specifying S3 Intelligent-Tiering filters. The filters determine the subset of objects to which the rule applies.

IntelligentTieringConfiguration

Specifies the S3 Intelligent-Tiering configuration for an Amazon S3 bucket.

IntelligentTieringFilter

The Filter is used to identify objects that the S3 Intelligent-Tiering configuration applies to.

InventoryConfiguration

Specifies the inventory configuration for an Amazon S3 bucket. For more information, see GET Bucket inventory in the Amazon S3 API Reference.

InventoryDestination

Specifies the inventory configuration for an Amazon S3 bucket.

InventoryEncryption

Contains the type of server-side encryption used to encrypt the inventory results.

InventoryFilter

Specifies an inventory filter. The inventory only includes objects that meet the filter's criteria.

InventoryS3BucketDestination

Contains the bucket name, file format, bucket owner (optional), and prefix (optional) where inventory results are published.

InventorySchedule

Specifies the schedule for generating inventory results.

JSONInput

Specifies JSON as object's input serialization format.

JSONOutput

Specifies JSON as request's output serialization format.

LambdaFunctionConfiguration

A container for specifying the configuration for Lambda notifications.

LifecycleConfiguration

Container for lifecycle rules. You can add as many as 1000 rules.

LifecycleExpiration

Container for the expiration for the lifecycle of the object.

LifecycleRule

A lifecycle rule for individual objects in an Amazon S3 bucket.

LifecycleRuleAndOperator

This is used in a Lifecycle Rule Filter to apply a logical AND to two or more predicates. The Lifecycle Rule will apply to any object matching all of the predicates configured inside the And operator.

LifecycleRuleFilter

The Filter is used to identify objects that a Lifecycle Rule applies to. A Filter must have exactly one of Prefix, Tag, or And specified.

ListBucketAnalyticsConfigurationsOutput
ListBucketAnalyticsConfigurationsRequest
ListBucketIntelligentTieringConfigurationsOutput
ListBucketIntelligentTieringConfigurationsRequest
ListBucketInventoryConfigurationsOutput
ListBucketInventoryConfigurationsRequest
ListBucketMetricsConfigurationsOutput
ListBucketMetricsConfigurationsRequest
ListBucketsOutput
ListMultipartUploadsOutput
ListMultipartUploadsRequest
ListObjectsOutput
ListObjectsRequest
ListObjectsV2Output
ListObjectsV2Request
ListObjectVersionsOutput
ListObjectVersionsRequest
ListPartsOutput
ListPartsRequest
LoggingEnabled

Describes where logs are stored and the prefix that Amazon S3 assigns to all log object keys for a bucket. For more information, see PUT Bucket logging in the Amazon S3 API Reference.

MetadataEntry

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

Metrics

A container specifying replication metrics-related settings enabling replication metrics and events.

MetricsAndOperator

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

Specifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID) from an Amazon S3 bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased. For more information, see PutBucketMetricsConfiguration.

MetricsFilter

Specifies a metrics configuration filter. The metrics configuration only includes objects that meet the filter's criteria. A filter must be a prefix, an object tag, an access point ARN, or a conjunction (MetricsAndOperator). For more information, see PutBucketMetricsConfiguration.

MultipartUpload

Container for the MultipartUpload for the Amazon S3 object.

NoncurrentVersionExpiration

Specifies when noncurrent object versions expire. Upon expiration, Amazon S3 permanently deletes the noncurrent object versions. You set this lifecycle configuration action on a bucket that has versioning enabled (or suspended) to request that Amazon S3 delete noncurrent object versions at a specific period in the object's lifetime.

NoncurrentVersionTransition

Container for the transition rule that describes when noncurrent objects transition to the STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER_IR, GLACIER, or DEEP_ARCHIVE storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to the STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER_IR, GLACIER, or DEEP_ARCHIVE storage class at a specific period in the object's lifetime.

NotificationConfiguration

A container for specifying the notification configuration of the bucket. If this element is empty, notifications are turned off for the bucket.

NotificationConfigurationDeprecated
NotificationConfigurationFilter

Specifies object key name filtering rules. For information about key name filtering, see Configuring Event Notifications in the Amazon S3 User Guide.

ObjectIdentifier

Object Identifier is unique value to identify objects.

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.

ObjectPart

A container for elements related to an individual part.

ObjectVersion

The version of an object.

OutputLocation

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

OutputSerialization

Describes how results of the Select job are serialized.

Owner

Container for the owner's display name and ID.

OwnershipControls

The container element for a bucket's ownership controls.

OwnershipControlsRule

The container element for an ownership control rule.

ParquetInput

Container for Parquet.

Part

Container for elements related to a part.

PolicyStatus

The container element for a bucket's policy status.

Progress

This data type contains information about progress of an operation.

ProgressEvent

This data type contains information about the progress event of an operation.

PublicAccessBlockConfiguration

The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see The Meaning of "Public" in the Amazon S3 User Guide.

PutBucketAccelerateConfigurationRequest
PutBucketAclRequest
PutBucketAnalyticsConfigurationRequest
PutBucketCorsRequest
PutBucketEncryptionRequest
PutBucketIntelligentTieringConfigurationRequest
PutBucketInventoryConfigurationRequest
PutBucketLifecycleConfigurationRequest
PutBucketLifecycleRequest
PutBucketLoggingRequest
PutBucketMetricsConfigurationRequest
PutBucketNotificationConfigurationRequest
PutBucketNotificationRequest
PutBucketOwnershipControlsRequest
PutBucketPolicyRequest
PutBucketReplicationRequest
PutBucketRequestPaymentRequest
PutBucketTaggingRequest
PutBucketVersioningRequest
PutBucketWebsiteRequest
PutObjectAclOutput
PutObjectAclRequest
PutObjectLegalHoldOutput
PutObjectLegalHoldRequest
PutObjectLockConfigurationOutput
PutObjectLockConfigurationRequest
PutObjectOutput
PutObjectRequest
PutObjectRetentionOutput
PutObjectRetentionRequest
PutObjectTaggingOutput
PutObjectTaggingRequest
PutPublicAccessBlockRequest
QueueConfiguration

Specifies the configuration for publishing messages to an Amazon Simple Queue Service (Amazon SQS) queue when Amazon S3 detects specified events.

QueueConfigurationDeprecated

This data type is deprecated. Use QueueConfiguration for the same purposes. This data type specifies the configuration for publishing messages to an Amazon Simple Queue Service (Amazon SQS) queue when Amazon S3 detects specified events.

RecordsEvent

The container for the records event.

Redirect

Specifies how requests are redirected. In the event of an error, you can specify a different error code to return.

RedirectAllRequestsTo

Specifies the redirect behavior of all requests to a website endpoint of an Amazon S3 bucket.

ReplicaModifications

A filter that you can specify for selection for modifications on replicas. Amazon S3 doesn't replicate replica modifications by default. In the latest version of replication configuration (when Filter is specified), you can specify this element and set the status to Enabled to replicate modifications on replicas.

ReplicationConfiguration

A container for replication rules. You can add up to 1,000 rules. The maximum size of a replication configuration is 2 MB.

ReplicationRule

Specifies which Amazon S3 objects to replicate and where to store the replicas.

ReplicationRuleAndOperator

A container for specifying rule filters. The filters determine the subset of objects to which the rule applies. This element is required only if you specify more than one filter.

ReplicationRuleFilter

A filter that identifies the 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 S3 Replication Time Control (S3 RTC) related information, including whether S3 RTC is enabled and the time when all objects and operations on objects must be replicated. Must be specified together with a Metrics block.

ReplicationTimeValue

A container specifying the time value for S3 Replication Time Control (S3 RTC) and replication metrics EventThreshold.

RequestPaymentConfiguration

Container for Payer.

RequestProgress

Container for specifying if periodic QueryProgress messages should be sent.

RestoreObjectOutput
RestoreObjectRequest
RestoreRequest

Container for restore job parameters.

RoutingRule

Specifies the redirect behavior and when a redirect is applied. For more information about routing rules, see Configuring advanced conditional redirects in the Amazon S3 User Guide.

Rule

Specifies lifecycle rules for an Amazon S3 bucket. For more information, see Put Bucket Lifecycle Configuration in the Amazon S3 API Reference. For examples, see Put Bucket Lifecycle Configuration Examples.

S3KeyFilter

A container for object key name prefix and suffix filtering rules.

S3Location

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

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. This parameter is optional, but when specified, it must not be empty. See RFC 2616, Section 14.35.1 about how to specify the start and end of the range.

SelectObjectContentEventStream

The container for selecting objects from a content event stream.

SelectObjectContentOutput
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 specify a data serialization format (JSON or CSV) of the object. Amazon S3 uses this to parse object data into records. It returns only records that match the specified SQL expression. You must also specify the data serialization format for the response. For more information, see S3Select API Documentation.

SelectParameters

Describes the parameters for Select job types.

ServerSideEncryptionByDefault

Describes the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied. If you don't specify a customer managed key at configuration, Amazon S3 automatically creates an Amazon Web Services KMS key in your Amazon Web Services account the first time that you add an object encrypted with SSE-KMS to a bucket. By default, Amazon S3 uses this KMS key for SSE-KMS. For more information, see PUT Bucket encryption in the Amazon S3 API Reference.

ServerSideEncryptionConfiguration

Specifies the default server-side-encryption configuration.

ServerSideEncryptionRule

Specifies the default server-side encryption configuration.

SourceSelectionCriteria

A container that describes additional filters for identifying the source objects that you want to replicate. You can choose to enable or disable the replication of these objects. Currently, Amazon S3 supports only the filter that you can specify for objects created with server-side encryption using a customer managed key stored in Amazon Web Services Key Management Service (SSE-KMS).

SSEKMS

Specifies the use of SSE-KMS to encrypt delivered inventory reports.

SseKmsEncryptedObjects

A container for filter information for the selection of S3 objects encrypted with Amazon Web Services KMS.

SSES3

Specifies the use of SSE-S3 to encrypt delivered inventory reports.

Stats

Container for the stats details.

StatsEvent

Container for the Stats Event.

StorageClassAnalysis

Specifies data related to access patterns to be collected and made available to analyze the tradeoffs between different storage classes for an Amazon S3 bucket.

StorageClassAnalysisDataExport

Container for data related to the storage class analysis for an Amazon S3 bucket for export.

Tag

A container of a key value name pair.

Tagging

Container for TagSet elements.

TargetGrant

Container for granting information.

Tiering

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without additional operational overhead.

TopicConfiguration

A container for specifying the configuration for publication of messages to an Amazon Simple Notification Service (Amazon SNS) topic when Amazon S3 detects specified events.

TopicConfigurationDeprecated

A container for specifying the configuration for publication of messages to an Amazon Simple Notification Service (Amazon SNS) topic when Amazon S3 detects specified events. This data type is deprecated. Use TopicConfiguration instead.

Transition

Specifies when an object transitions to a specified storage class. For more information about Amazon S3 lifecycle configuration rules, see Transitioning Objects Using Amazon S3 Lifecycle in the Amazon S3 User Guide.

UploadPartCopyOutput
UploadPartCopyRequest
UploadPartOutput
UploadPartRequest
VersioningConfiguration

Describes the versioning state of an Amazon S3 bucket. For more information, see PUT Bucket versioning in the Amazon S3 API Reference.

WebsiteConfiguration

Specifies website configuration parameters for an Amazon S3 bucket.

WriteGetObjectResponseRequest

§Type Aliases

AnalyticsS3ExportFileFormat
ArchiveStatus
BucketAccelerateStatus
BucketCannedACL
BucketLocationConstraint
BucketLogsPermission
BucketVersioningStatus
ChecksumAlgorithm
ChecksumMode
CompressionType
DeleteMarkerReplicationStatus
EncodingType

Requests Amazon S3 to encode the object keys in the response and specifies the encoding method to use. An object key may contain any Unicode character; however, XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response.

Event

The bucket event for which to send notifications.

ExistingObjectReplicationStatus
ExpirationStatus
ExpressionType
FileHeaderInfo
FilterRuleName
IntelligentTieringAccessTier
IntelligentTieringStatus
InventoryFormat
InventoryFrequency
InventoryIncludedObjectVersions
InventoryOptionalField
JSONType
MetadataDirective
MetricsStatus
MFADelete
MFADeleteStatus
ObjectAttributes
ObjectCannedACL
ObjectLockEnabled
ObjectLockLegalHoldStatus
ObjectLockMode
ObjectLockRetentionMode
ObjectOwnership

The container element for object ownership for a bucket's ownership controls.

ObjectStorageClass
ObjectVersionStorageClass
OwnerOverride
Payer
Permission
Protocol
QuoteFields
ReplicaModificationsStatus
ReplicationRuleStatus
ReplicationStatus
ReplicationTimeStatus
RequestCharged

If present, indicates that the requester was successfully charged for the request.

RequestPayer

Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

RestoreRequestType
ServerSideEncryption
SseKmsEncryptedObjectsStatus
StorageClass
StorageClassAnalysisSchemaVersion
TaggingDirective
Tier
TransitionStorageClass
Type