Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace S3

Index

References

Namespaces

Classes

Interfaces

Type aliases

References

Types

Renames and exports S3

Type aliases

AbortDate

AbortDate: Date

AbortRuleId

AbortRuleId: string

AcceptRanges

AcceptRanges: string

AccountId

AccountId: string

AllowQuotedRecordDelimiter

AllowQuotedRecordDelimiter: boolean

AllowedHeader

AllowedHeader: string

AllowedHeaders

AllowedHeaders: AllowedHeader[]

AllowedMethod

AllowedMethod: string

AllowedMethods

AllowedMethods: AllowedMethod[]

AllowedOrigin

AllowedOrigin: string

AllowedOrigins

AllowedOrigins: AllowedOrigin[]

AnalyticsConfigurationList

AnalyticsConfigurationList: AnalyticsConfiguration[]

AnalyticsId

AnalyticsId: string

AnalyticsS3ExportFileFormat

AnalyticsS3ExportFileFormat: "CSV" | string

ArchiveStatus

ArchiveStatus: "ARCHIVE_ACCESS" | "DEEP_ARCHIVE_ACCESS" | string

Body

Body: Buffer | Uint8Array | Blob | string | Readable

BucketAccelerateStatus

BucketAccelerateStatus: "Enabled" | "Suspended" | string

BucketCannedACL

BucketCannedACL: "private" | "public-read" | "public-read-write" | "authenticated-read" | string

BucketKeyEnabled

BucketKeyEnabled: boolean

BucketLocationConstraint

BucketLocationConstraint: "af-south-1" | "ap-east-1" | "ap-northeast-1" | "ap-northeast-2" | "ap-northeast-3" | "ap-south-1" | "ap-southeast-1" | "ap-southeast-2" | "ca-central-1" | "cn-north-1" | "cn-northwest-1" | "EU" | "eu-central-1" | "eu-north-1" | "eu-south-1" | "eu-west-1" | "eu-west-2" | "eu-west-3" | "me-south-1" | "sa-east-1" | "us-east-2" | "us-gov-east-1" | "us-gov-west-1" | "us-west-1" | "us-west-2" | string

BucketLogsPermission

BucketLogsPermission: "FULL_CONTROL" | "READ" | "WRITE" | string

BucketName

BucketName: string

BucketVersioningStatus

BucketVersioningStatus: "Enabled" | "Suspended" | string

Buckets

Buckets: Bucket[]

BypassGovernanceRetention

BypassGovernanceRetention: boolean

BytesProcessed

BytesProcessed: number

BytesReturned

BytesReturned: number

BytesScanned

BytesScanned: number

CORSRules

CORSRules: CORSRule[]

CacheControl

CacheControl: string

ClientConfiguration

ClientConfiguration: ServiceConfigurationOptions & UseDualstackConfigOptions & ClientApiVersions

CloudFunction

CloudFunction: string

CloudFunctionInvocationRole

CloudFunctionInvocationRole: string

Code

Code: string

Comments

Comments: string

CommonPrefixList

CommonPrefixList: CommonPrefix[]

CompletedPartList

CompletedPartList: CompletedPart[]

CompressionType

CompressionType: "NONE" | "GZIP" | "BZIP2" | string

ConfirmRemoveSelfBucketAccess

ConfirmRemoveSelfBucketAccess: boolean

ContentDisposition

ContentDisposition: string

ContentEncoding

ContentEncoding: string

ContentLanguage

ContentLanguage: string

ContentLength

ContentLength: number

ContentMD5

ContentMD5: string

ContentRange

ContentRange: string

ContentType

ContentType: string

CopySource

CopySource: string

CopySourceIfMatch

CopySourceIfMatch: string

CopySourceIfModifiedSince

CopySourceIfModifiedSince: Date

CopySourceIfNoneMatch

CopySourceIfNoneMatch: string

CopySourceIfUnmodifiedSince

CopySourceIfUnmodifiedSince: Date

CopySourceRange

CopySourceRange: string

CopySourceSSECustomerAlgorithm

CopySourceSSECustomerAlgorithm: string

CopySourceSSECustomerKey

CopySourceSSECustomerKey: Buffer | Uint8Array | Blob | string

CopySourceSSECustomerKeyMD5

CopySourceSSECustomerKeyMD5: string

CopySourceVersionId

CopySourceVersionId: string

CreationDate

CreationDate: Date

Days

Days: number

DaysAfterInitiation

DaysAfterInitiation: number

DeleteMarker

DeleteMarker: boolean

DeleteMarkerReplicationStatus

DeleteMarkerReplicationStatus: "Enabled" | "Disabled" | string

DeleteMarkerVersionId

DeleteMarkerVersionId: string

DeleteMarkers

DeleteMarkers: DeleteMarkerEntry[]

DeletedObjects

DeletedObjects: DeletedObject[]

Delimiter

Delimiter: string

Description

Description: string

DisplayName

DisplayName: string

ETag

ETag: string

EmailAddress

EmailAddress: string

EnableRequestProgress

EnableRequestProgress: boolean

EncodingType

EncodingType: "url" | string

End

End: number

ErrorCode

ErrorCode: string

ErrorMessage

ErrorMessage: string

Errors

Errors: Error[]

Event

Event: "s3:ReducedRedundancyLostObject" | "s3:ObjectCreated:*" | "s3:ObjectCreated:Put" | "s3:ObjectCreated:Post" | "s3:ObjectCreated:Copy" | "s3:ObjectCreated:CompleteMultipartUpload" | "s3:ObjectRemoved:*" | "s3:ObjectRemoved:Delete" | "s3:ObjectRemoved:DeleteMarkerCreated" | "s3:ObjectRestore:*" | "s3:ObjectRestore:Post" | "s3:ObjectRestore:Completed" | "s3:Replication:*" | "s3:Replication:OperationFailedReplication" | "s3:Replication:OperationNotTracked" | "s3:Replication:OperationMissedThreshold" | "s3:Replication:OperationReplicatedAfterThreshold" | string

EventList

EventList: Event[]

ExistingObjectReplicationStatus

ExistingObjectReplicationStatus: "Enabled" | "Disabled" | string

Expiration

Expiration: string

ExpirationStatus

ExpirationStatus: "Enabled" | "Disabled" | string

ExpiredObjectDeleteMarker

ExpiredObjectDeleteMarker: boolean

Expires

Expires: Date

ExposeHeader

ExposeHeader: string

ExposeHeaders

ExposeHeaders: ExposeHeader[]

Expression

Expression: string

ExpressionType

ExpressionType: "SQL" | string

FetchOwner

FetchOwner: boolean

FieldDelimiter

FieldDelimiter: string

FileHeaderInfo

FileHeaderInfo: "USE" | "IGNORE" | "NONE" | string

FilterRuleList

FilterRuleList: FilterRule[]

FilterRuleName

FilterRuleName: "prefix" | "suffix" | string

FilterRuleValue

FilterRuleValue: string

GetObjectResponseStatusCode

GetObjectResponseStatusCode: number

GrantFullControl

GrantFullControl: string

GrantRead

GrantRead: string

GrantReadACP

GrantReadACP: string

GrantWrite

GrantWrite: string

GrantWriteACP

GrantWriteACP: string

Grants

Grants: Grant[]

HostName

HostName: string

HttpErrorCodeReturnedEquals

HttpErrorCodeReturnedEquals: string

HttpRedirectCode

HttpRedirectCode: string

ID

ID: string

IfMatch

IfMatch: string

IfModifiedSince

IfModifiedSince: Date

IfNoneMatch

IfNoneMatch: string

IfUnmodifiedSince

IfUnmodifiedSince: Date

Initiated

Initiated: Date

IntelligentTieringAccessTier

IntelligentTieringAccessTier: "ARCHIVE_ACCESS" | "DEEP_ARCHIVE_ACCESS" | string

IntelligentTieringConfigurationList

IntelligentTieringConfigurationList: IntelligentTieringConfiguration[]

IntelligentTieringDays

IntelligentTieringDays: number

IntelligentTieringId

IntelligentTieringId: string

IntelligentTieringStatus

IntelligentTieringStatus: "Enabled" | "Disabled" | string

InventoryConfigurationList

InventoryConfigurationList: InventoryConfiguration[]

InventoryFormat

InventoryFormat: "CSV" | "ORC" | "Parquet" | string

InventoryFrequency

InventoryFrequency: "Daily" | "Weekly" | string

InventoryId

InventoryId: string

InventoryIncludedObjectVersions

InventoryIncludedObjectVersions: "All" | "Current" | string

InventoryOptionalField

InventoryOptionalField: "Size" | "LastModifiedDate" | "StorageClass" | "ETag" | "IsMultipartUploaded" | "ReplicationStatus" | "EncryptionStatus" | "ObjectLockRetainUntilDate" | "ObjectLockMode" | "ObjectLockLegalHoldStatus" | "IntelligentTieringAccessTier" | string

InventoryOptionalFields

InventoryOptionalFields: InventoryOptionalField[]

IsEnabled

IsEnabled: boolean

IsLatest

IsLatest: boolean

IsPublic

IsPublic: boolean

IsTruncated

IsTruncated: boolean

JSONType

JSONType: "DOCUMENT" | "LINES" | string

KMSContext

KMSContext: string

KeyCount

KeyCount: number

KeyMarker

KeyMarker: string

KeyPrefixEquals

KeyPrefixEquals: string

LambdaFunctionArn

LambdaFunctionArn: string

LambdaFunctionConfigurationList

LambdaFunctionConfigurationList: LambdaFunctionConfiguration[]

LastModified

LastModified: Date

LifecycleRules

LifecycleRules: LifecycleRule[]

Location

Location: string

LocationPrefix

LocationPrefix: string

MFA

MFA: string

MFADelete

MFADelete: "Enabled" | "Disabled" | string

MFADeleteStatus

MFADeleteStatus: "Enabled" | "Disabled" | string

Marker

Marker: string

MaxAgeSeconds

MaxAgeSeconds: number

MaxKeys

MaxKeys: number

MaxParts

MaxParts: number

MaxUploads

MaxUploads: number

Message

Message: string

Metadata

Metadata: {}

Type declaration

MetadataDirective

MetadataDirective: "COPY" | "REPLACE" | string

MetadataKey

MetadataKey: string

MetadataValue

MetadataValue: string

MetricsConfigurationList

MetricsConfigurationList: MetricsConfiguration[]

MetricsId

MetricsId: string

MetricsStatus

MetricsStatus: "Enabled" | "Disabled" | string

Minutes

Minutes: number

MissingMeta

MissingMeta: number

MultipartUploadId

MultipartUploadId: string

MultipartUploadList

MultipartUploadList: MultipartUpload[]

NextKeyMarker

NextKeyMarker: string

NextMarker

NextMarker: string

NextPartNumberMarker

NextPartNumberMarker: number

NextToken

NextToken: string

NextUploadIdMarker

NextUploadIdMarker: string

NextVersionIdMarker

NextVersionIdMarker: string

NoncurrentVersionTransitionList

NoncurrentVersionTransitionList: NoncurrentVersionTransition[]

NotificationId

NotificationId: string

ObjectCannedACL

ObjectCannedACL: "private" | "public-read" | "public-read-write" | "authenticated-read" | "aws-exec-read" | "bucket-owner-read" | "bucket-owner-full-control" | string

ObjectIdentifierList

ObjectIdentifierList: ObjectIdentifier[]

ObjectKey

ObjectKey: string

ObjectList

ObjectList: Object[]

ObjectLockEnabled

ObjectLockEnabled: "Enabled" | string

ObjectLockEnabledForBucket

ObjectLockEnabledForBucket: boolean

ObjectLockLegalHoldStatus

ObjectLockLegalHoldStatus: "ON" | "OFF" | string

ObjectLockMode

ObjectLockMode: "GOVERNANCE" | "COMPLIANCE" | string

ObjectLockRetainUntilDate

ObjectLockRetainUntilDate: Date

ObjectLockRetentionMode

ObjectLockRetentionMode: "GOVERNANCE" | "COMPLIANCE" | string

ObjectLockToken

ObjectLockToken: string

ObjectOwnership

ObjectOwnership: "BucketOwnerPreferred" | "ObjectWriter" | string

ObjectStorageClass

ObjectStorageClass: "STANDARD" | "REDUCED_REDUNDANCY" | "GLACIER" | "STANDARD_IA" | "ONEZONE_IA" | "INTELLIGENT_TIERING" | "DEEP_ARCHIVE" | "OUTPOSTS" | string

ObjectVersionId

ObjectVersionId: string

ObjectVersionList

ObjectVersionList: ObjectVersion[]

ObjectVersionStorageClass

ObjectVersionStorageClass: "STANDARD" | string

OwnerOverride

OwnerOverride: "Destination" | string

OwnershipControlsRules

OwnershipControlsRules: OwnershipControlsRule[]

PartNumber

PartNumber: number

PartNumberMarker

PartNumberMarker: number

Parts

Parts: Part[]

PartsCount

PartsCount: number

Payer

Payer: "Requester" | "BucketOwner" | string

Permission

Permission: "FULL_CONTROL" | "WRITE" | "WRITE_ACP" | "READ" | "READ_ACP" | string

Policy

Policy: string

Prefix

Prefix: string

Priority

Priority: number

Protocol

Protocol: "http" | "https" | string

QueueArn

QueueArn: string

QueueConfigurationList

QueueConfigurationList: QueueConfiguration[]

Quiet

Quiet: boolean

QuoteCharacter

QuoteCharacter: string

QuoteEscapeCharacter

QuoteEscapeCharacter: string

QuoteFields

QuoteFields: "ALWAYS" | "ASNEEDED" | string

Range

Range: string

RecordDelimiter

RecordDelimiter: string

ReplaceKeyPrefixWith

ReplaceKeyPrefixWith: string

ReplaceKeyWith

ReplaceKeyWith: string

ReplicaKmsKeyID

ReplicaKmsKeyID: string

ReplicaModificationsStatus

ReplicaModificationsStatus: "Enabled" | "Disabled" | string

ReplicationRuleStatus

ReplicationRuleStatus: "Enabled" | "Disabled" | string

ReplicationRules

ReplicationRules: ReplicationRule[]

ReplicationStatus

ReplicationStatus: "COMPLETE" | "PENDING" | "FAILED" | "REPLICA" | string

ReplicationTimeStatus

ReplicationTimeStatus: "Enabled" | "Disabled" | string

RequestCharged

RequestCharged: "requester" | string

RequestPayer

RequestPayer: "requester" | string

RequestRoute

RequestRoute: string

RequestToken

RequestToken: string

ResponseCacheControl

ResponseCacheControl: string

ResponseContentDisposition

ResponseContentDisposition: string

ResponseContentEncoding

ResponseContentEncoding: string

ResponseContentLanguage

ResponseContentLanguage: string

ResponseContentType

ResponseContentType: string

ResponseExpires

ResponseExpires: Date

Restore

Restore: string

RestoreOutputPath

RestoreOutputPath: string

RestoreRequestType

RestoreRequestType: "SELECT" | string

Role

Role: string

RoutingRules

RoutingRules: RoutingRule[]

Rules

Rules: Rule[]

SSECustomerAlgorithm

SSECustomerAlgorithm: string

SSECustomerKey

SSECustomerKey: Buffer | Uint8Array | Blob | string

SSECustomerKeyMD5

SSECustomerKeyMD5: string

SSEKMSEncryptionContext

SSEKMSEncryptionContext: string

SSEKMSKeyId

SSEKMSKeyId: string

SelectObjectContentEventStream

SelectObjectContentEventStream: EventStream<{ Cont?: ContinuationEvent; End?: EndEvent; Progress?: ProgressEvent; Records?: RecordsEvent; Stats?: StatsEvent }>

ServerSideEncryption

ServerSideEncryption: "AES256" | "aws:kms" | string

ServerSideEncryptionRules

ServerSideEncryptionRules: ServerSideEncryptionRule[]

Setting

Setting: boolean

Size

Size: number

SseKmsEncryptedObjectsStatus

SseKmsEncryptedObjectsStatus: "Enabled" | "Disabled" | string

Start

Start: number

StartAfter

StartAfter: string

StorageClass

StorageClass: "STANDARD" | "REDUCED_REDUNDANCY" | "STANDARD_IA" | "ONEZONE_IA" | "INTELLIGENT_TIERING" | "GLACIER" | "DEEP_ARCHIVE" | "OUTPOSTS" | string

StorageClassAnalysisSchemaVersion

StorageClassAnalysisSchemaVersion: "V_1" | string

Suffix

Suffix: string

TagCount

TagCount: number

TagSet

TagSet: Tag[]

TaggingDirective

TaggingDirective: "COPY" | "REPLACE" | string

TaggingHeader

TaggingHeader: string

TargetBucket

TargetBucket: string

TargetGrants

TargetGrants: TargetGrant[]

TargetPrefix

TargetPrefix: string

Tier

Tier: "Standard" | "Bulk" | "Expedited" | string

TieringList

TieringList: Tiering[]

Token

Token: string

TopicArn

TopicArn: string

TopicConfigurationList

TopicConfigurationList: TopicConfiguration[]

TransitionList

TransitionList: Transition[]

TransitionStorageClass

TransitionStorageClass: "GLACIER" | "STANDARD_IA" | "ONEZONE_IA" | "INTELLIGENT_TIERING" | "DEEP_ARCHIVE" | string

Type

Type: "CanonicalUser" | "AmazonCustomerByEmail" | "Group" | string

URI

URI: string

UploadIdMarker

UploadIdMarker: string

UserMetadata

UserMetadata: MetadataEntry[]

Value

Value: string

VersionIdMarker

VersionIdMarker: string

WebsiteRedirectLocation

WebsiteRedirectLocation: string

Years

Years: number

_Date

_Date: Date

apiVersion

apiVersion: "2006-03-01" | "latest" | string

A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.

Generated using TypeDoc