@tachybase/module-file 0.23.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +9 -0
- package/README.zh-CN.md +9 -0
- package/client.d.ts +2 -0
- package/client.js +1 -0
- package/dist/client/FileManagerProvider.d.ts +4 -0
- package/dist/client/FileStorage.d.ts +4 -0
- package/dist/client/StorageOptions.d.ts +2 -0
- package/dist/client/hooks/index.d.ts +1 -0
- package/dist/client/hooks/useUploadFiles.d.ts +9 -0
- package/dist/client/index.d.ts +7 -0
- package/dist/client/index.js +1 -0
- package/dist/client/initializers/UploadActionInitializer.d.ts +2 -0
- package/dist/client/initializers/index.d.ts +1 -0
- package/dist/client/interfaces/attachment.d.ts +103 -0
- package/dist/client/locale/index.d.ts +2 -0
- package/dist/client/schemas/storage.d.ts +11 -0
- package/dist/client/schemas/storageTypes/ali-oss.d.ts +82 -0
- package/dist/client/schemas/storageTypes/index.d.ts +284 -0
- package/dist/client/schemas/storageTypes/local.d.ts +56 -0
- package/dist/client/schemas/storageTypes/s3.d.ts +77 -0
- package/dist/client/schemas/storageTypes/tx-cos.d.ts +71 -0
- package/dist/client/templates/file.d.ts +133 -0
- package/dist/client/templates/index.d.ts +1 -0
- package/dist/externalVersion.js +16 -0
- package/dist/index.d.ts +2 -0
- package/dist/index.js +39 -0
- package/dist/locale/en-US.json +22 -0
- package/dist/locale/fr-FR.json +21 -0
- package/dist/locale/ja-JP.json +18 -0
- package/dist/locale/ko_KR.json +32 -0
- package/dist/locale/ru-RU.json +18 -0
- package/dist/locale/tr-TR.json +17 -0
- package/dist/locale/zh-CN.json +32 -0
- package/dist/node_modules/@aws-sdk/client-s3/LICENSE +201 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-cjs/auth/httpAuthSchemeProvider.js +127 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-cjs/endpoint/endpointResolver.js +33 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-cjs/endpoint/ruleset.js +7 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-cjs/index.js +1 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-cjs/runtimeConfig.browser.js +47 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-cjs/runtimeConfig.js +69 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-cjs/runtimeConfig.native.js +15 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-cjs/runtimeConfig.shared.js +46 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/S3.js +203 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/S3Client.js +60 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/auth/httpAuthExtensionConfiguration.js +38 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/auth/httpAuthSchemeProvider.js +123 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/AbortMultipartUploadCommand.js +28 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/CompleteMultipartUploadCommand.js +31 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/CopyObjectCommand.js +33 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/CreateBucketCommand.js +31 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/CreateBucketMetadataTableConfigurationCommand.js +31 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/CreateMultipartUploadCommand.js +31 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/CreateSessionCommand.js +29 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/DeleteBucketAnalyticsConfigurationCommand.js +26 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/DeleteBucketCommand.js +26 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/DeleteBucketCorsCommand.js +26 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/DeleteBucketEncryptionCommand.js +26 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/DeleteBucketIntelligentTieringConfigurationCommand.js +26 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/DeleteBucketInventoryConfigurationCommand.js +26 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/DeleteBucketLifecycleCommand.js +26 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/DeleteBucketMetadataTableConfigurationCommand.js +26 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/DeleteBucketMetricsConfigurationCommand.js +26 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/DeleteBucketOwnershipControlsCommand.js +26 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/DeleteBucketPolicyCommand.js +26 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/DeleteBucketReplicationCommand.js +26 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/DeleteBucketTaggingCommand.js +26 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/DeleteBucketWebsiteCommand.js +26 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/DeleteObjectCommand.js +28 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/DeleteObjectTaggingCommand.js +27 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/DeleteObjectsCommand.js +32 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/DeletePublicAccessBlockCommand.js +26 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/GetBucketAccelerateConfigurationCommand.js +28 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/GetBucketAclCommand.js +28 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/GetBucketAnalyticsConfigurationCommand.js +28 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/GetBucketCorsCommand.js +28 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/GetBucketEncryptionCommand.js +29 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/GetBucketIntelligentTieringConfigurationCommand.js +28 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/GetBucketInventoryConfigurationCommand.js +29 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/GetBucketLifecycleConfigurationCommand.js +28 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/GetBucketLocationCommand.js +28 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/GetBucketLoggingCommand.js +28 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/GetBucketMetadataTableConfigurationCommand.js +28 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/GetBucketMetricsConfigurationCommand.js +28 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/GetBucketNotificationConfigurationCommand.js +28 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/GetBucketOwnershipControlsCommand.js +28 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/GetBucketPolicyCommand.js +28 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/GetBucketPolicyStatusCommand.js +28 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/GetBucketReplicationCommand.js +28 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/GetBucketRequestPaymentCommand.js +28 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/GetBucketTaggingCommand.js +28 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/GetBucketVersioningCommand.js +28 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/GetBucketWebsiteCommand.js +28 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/GetObjectAclCommand.js +28 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/GetObjectAttributesCommand.js +30 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/GetObjectCommand.js +37 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/GetObjectLegalHoldCommand.js +27 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/GetObjectLockConfigurationCommand.js +27 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/GetObjectRetentionCommand.js +27 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/GetObjectTaggingCommand.js +27 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/GetObjectTorrentCommand.js +26 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/GetPublicAccessBlockCommand.js +28 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/HeadBucketCommand.js +27 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/HeadObjectCommand.js +32 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/ListBucketAnalyticsConfigurationsCommand.js +28 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/ListBucketIntelligentTieringConfigurationsCommand.js +28 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/ListBucketInventoryConfigurationsCommand.js +29 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/ListBucketMetricsConfigurationsCommand.js +27 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/ListBucketsCommand.js +24 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/ListDirectoryBucketsCommand.js +27 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/ListMultipartUploadsCommand.js +28 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/ListObjectVersionsCommand.js +28 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/ListObjectsCommand.js +28 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/ListObjectsV2Command.js +28 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/ListPartsCommand.js +31 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/PutBucketAccelerateConfigurationCommand.js +31 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/PutBucketAclCommand.js +31 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/PutBucketAnalyticsConfigurationCommand.js +26 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/PutBucketCorsCommand.js +31 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/PutBucketEncryptionCommand.js +32 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/PutBucketIntelligentTieringConfigurationCommand.js +26 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/PutBucketInventoryConfigurationCommand.js +27 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/PutBucketLifecycleConfigurationCommand.js +33 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/PutBucketLoggingCommand.js +31 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/PutBucketMetricsConfigurationCommand.js +26 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/PutBucketNotificationConfigurationCommand.js +26 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/PutBucketOwnershipControlsCommand.js +30 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/PutBucketPolicyCommand.js +31 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/PutBucketReplicationCommand.js +31 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/PutBucketRequestPaymentCommand.js +31 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/PutBucketTaggingCommand.js +31 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/PutBucketVersioningCommand.js +31 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/PutBucketWebsiteCommand.js +31 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/PutObjectAclCommand.js +33 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/PutObjectCommand.js +37 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/PutObjectLegalHoldCommand.js +32 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/PutObjectLockConfigurationCommand.js +32 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/PutObjectRetentionCommand.js +32 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/PutObjectTaggingCommand.js +32 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/PutPublicAccessBlockCommand.js +31 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/RestoreObjectCommand.js +33 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/SelectObjectContentCommand.js +34 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/UploadPartCommand.js +36 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/UploadPartCopyCommand.js +31 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/WriteGetObjectResponseCommand.js +26 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/commands/index.js +98 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/endpoint/EndpointParameters.js +24 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/endpoint/endpointResolver.js +29 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/endpoint/ruleset.js +4 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/extensionConfiguration.js +1 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/index.js +7 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/models/S3ServiceException.js +8 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/models/index.js +2 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/models/models_0.js +580 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/models/models_1.js +198 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/pagination/Interfaces.js +1 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/pagination/ListBucketsPaginator.js +4 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/pagination/ListDirectoryBucketsPaginator.js +4 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/pagination/ListObjectsV2Paginator.js +4 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/pagination/ListPartsPaginator.js +4 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/pagination/index.js +5 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/protocols/Aws_restXml.js +7635 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/runtimeConfig.browser.js +42 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/runtimeConfig.js +64 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/runtimeConfig.native.js +11 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/runtimeConfig.shared.js +42 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/runtimeExtensions.js +21 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/waiters/index.js +4 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/waiters/waitForBucketExists.js +26 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/waiters/waitForBucketNotExists.js +25 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/waiters/waitForObjectExists.js +26 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-es/waiters/waitForObjectNotExists.js +25 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/S3.d.ts +698 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/S3Client.d.ts +331 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/auth/httpAuthExtensionConfiguration.d.ts +29 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/auth/httpAuthSchemeProvider.d.ts +69 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/AbortMultipartUploadCommand.d.ts +179 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/CompleteMultipartUploadCommand.d.ts +311 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/CopyObjectCommand.d.ts +348 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/CreateBucketCommand.d.ts +283 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/CreateBucketMetadataTableConfigurationCommand.d.ts +134 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/CreateMultipartUploadCommand.d.ts +399 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/CreateSessionCommand.d.ts +196 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/DeleteBucketAnalyticsConfigurationCommand.d.ts +101 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/DeleteBucketCommand.d.ts +138 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/DeleteBucketCorsCommand.d.ts +104 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/DeleteBucketEncryptionCommand.d.ts +130 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/DeleteBucketIntelligentTieringConfigurationCommand.d.ts +94 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/DeleteBucketInventoryConfigurationCommand.d.ts +99 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/DeleteBucketLifecycleCommand.d.ts +150 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/DeleteBucketMetadataTableConfigurationCommand.d.ts +95 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/DeleteBucketMetricsConfigurationCommand.d.ts +107 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/DeleteBucketOwnershipControlsCommand.d.ts +91 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/DeleteBucketPolicyCommand.d.ts +147 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/DeleteBucketReplicationCommand.d.ts +108 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/DeleteBucketTaggingCommand.d.ts +100 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/DeleteBucketWebsiteCommand.d.ts +107 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/DeleteObjectCommand.d.ts +205 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/DeleteObjectTaggingCommand.d.ts +131 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/DeleteObjectsCommand.d.ts +317 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/DeletePublicAccessBlockCommand.d.ts +100 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/GetBucketAccelerateConfigurationCommand.d.ts +102 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/GetBucketAclCommand.d.ts +115 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/GetBucketAnalyticsConfigurationCommand.d.ts +135 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/GetBucketCorsCommand.d.ts +145 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/GetBucketEncryptionCommand.d.ts +143 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/GetBucketIntelligentTieringConfigurationCommand.d.ts +121 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/GetBucketInventoryConfigurationCommand.d.ts +129 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/GetBucketLifecycleConfigurationCommand.d.ts +254 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/GetBucketLocationCommand.d.ts +116 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/GetBucketLoggingCommand.d.ts +110 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/GetBucketMetadataTableConfigurationCommand.d.ts +111 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/GetBucketMetricsConfigurationCommand.d.ts +128 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/GetBucketNotificationConfigurationCommand.d.ts +154 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/GetBucketOwnershipControlsCommand.d.ts +99 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/GetBucketPolicyCommand.d.ts +159 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/GetBucketPolicyStatusCommand.d.ts +105 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/GetBucketReplicationCommand.d.ts +195 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/GetBucketRequestPaymentCommand.d.ts +101 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/GetBucketTaggingCommand.d.ts +134 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/GetBucketVersioningCommand.d.ts +115 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/GetBucketWebsiteCommand.d.ts +139 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/GetObjectAclCommand.d.ts +189 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/GetObjectAttributesCommand.d.ts +326 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/GetObjectCommand.d.ts +367 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/GetObjectLegalHoldCommand.d.ts +90 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/GetObjectLockConfigurationCommand.d.ts +94 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/GetObjectRetentionCommand.d.ts +91 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/GetObjectTaggingCommand.d.ts +163 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/GetObjectTorrentCommand.d.ts +107 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/GetPublicAccessBlockCommand.d.ts +116 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/HeadBucketCommand.d.ts +157 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/HeadObjectCommand.d.ts +315 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/ListBucketAnalyticsConfigurationsCommand.d.ts +147 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/ListBucketIntelligentTieringConfigurationsCommand.d.ts +126 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/ListBucketInventoryConfigurationsCommand.d.ts +142 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/ListBucketMetricsConfigurationsCommand.d.ts +136 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/ListBucketsCommand.d.ts +130 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/ListDirectoryBucketsCommand.d.ts +107 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/ListMultipartUploadsCommand.d.ts +344 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/ListObjectVersionsCommand.d.ts +213 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/ListObjectsCommand.d.ts +196 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/ListObjectsV2Command.d.ts +261 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/ListPartsCommand.d.ts +238 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/PutBucketAccelerateConfigurationCommand.d.ts +115 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/PutBucketAclCommand.d.ts +309 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/PutBucketAnalyticsConfigurationCommand.d.ts +208 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/PutBucketCorsCommand.d.ts +193 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/PutBucketEncryptionCommand.d.ts +209 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/PutBucketIntelligentTieringConfigurationCommand.d.ts +153 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/PutBucketInventoryConfigurationCommand.d.ts +185 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/PutBucketLifecycleConfigurationCommand.d.ts +293 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/PutBucketLoggingCommand.d.ts +209 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/PutBucketMetricsConfigurationCommand.d.ts +141 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/PutBucketNotificationConfigurationCommand.d.ts +206 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/PutBucketOwnershipControlsCommand.d.ts +99 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/PutBucketPolicyCommand.d.ts +162 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/PutBucketReplicationCommand.d.ts +233 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/PutBucketRequestPaymentCommand.d.ts +109 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/PutBucketTaggingCommand.d.ts +163 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/PutBucketVersioningCommand.d.ts +143 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/PutBucketWebsiteCommand.d.ts +244 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/PutObjectAclCommand.d.ts +307 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/PutObjectCommand.d.ts +449 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/PutObjectLegalHoldCommand.d.ts +86 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/PutObjectLockConfigurationCommand.d.ts +109 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/PutObjectRetentionCommand.d.ts +89 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/PutObjectTaggingCommand.d.ts +169 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/PutPublicAccessBlockCommand.d.ts +117 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/RestoreObjectCommand.d.ts +383 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/SelectObjectContentCommand.d.ts +254 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/UploadPartCommand.d.ts +307 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/UploadPartCopyCommand.d.ts +375 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/WriteGetObjectResponseCommand.d.ts +147 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/index.d.ts +98 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/endpoint/EndpointParameters.d.ts +83 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/endpoint/endpointResolver.d.ts +5 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/endpoint/ruleset.d.ts +2 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/extensionConfiguration.d.ts +9 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/index.d.ts +15 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/models/S3ServiceException.d.ts +14 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/models/index.d.ts +2 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/models/models_0.d.ts +13234 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/models/models_1.d.ts +3948 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/pagination/Interfaces.d.ts +8 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/pagination/ListBucketsPaginator.d.ts +7 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/pagination/ListDirectoryBucketsPaginator.d.ts +7 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/pagination/ListObjectsV2Paginator.d.ts +7 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/pagination/ListPartsPaginator.d.ts +7 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/pagination/index.d.ts +5 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/protocols/Aws_restXml.d.ts +884 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/runtimeConfig.browser.d.ts +68 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/runtimeConfig.d.ts +69 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/runtimeConfig.native.d.ts +67 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/runtimeConfig.shared.d.ts +28 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/runtimeExtensions.d.ts +17 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/S3.d.ts +1751 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/S3Client.d.ts +732 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/auth/httpAuthExtensionConfiguration.d.ts +32 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/auth/httpAuthSchemeProvider.d.ts +55 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/AbortMultipartUploadCommand.d.ts +51 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/CompleteMultipartUploadCommand.d.ts +51 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/CopyObjectCommand.d.ts +47 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/CreateBucketCommand.d.ts +47 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/CreateBucketMetadataTableConfigurationCommand.d.ts +47 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/CreateMultipartUploadCommand.d.ts +51 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/CreateSessionCommand.d.ts +47 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/DeleteBucketAnalyticsConfigurationCommand.d.ts +47 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/DeleteBucketCommand.d.ts +45 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/DeleteBucketCorsCommand.d.ts +45 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/DeleteBucketEncryptionCommand.d.ts +46 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/DeleteBucketIntelligentTieringConfigurationCommand.d.ts +47 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/DeleteBucketInventoryConfigurationCommand.d.ts +47 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/DeleteBucketLifecycleCommand.d.ts +46 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/DeleteBucketMetadataTableConfigurationCommand.d.ts +47 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/DeleteBucketMetricsConfigurationCommand.d.ts +47 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/DeleteBucketOwnershipControlsCommand.d.ts +47 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/DeleteBucketPolicyCommand.d.ts +46 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/DeleteBucketReplicationCommand.d.ts +47 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/DeleteBucketTaggingCommand.d.ts +46 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/DeleteBucketWebsiteCommand.d.ts +46 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/DeleteObjectCommand.d.ts +47 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/DeleteObjectTaggingCommand.d.ts +51 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/DeleteObjectsCommand.d.ts +47 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/DeletePublicAccessBlockCommand.d.ts +47 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/GetBucketAccelerateConfigurationCommand.d.ts +51 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/GetBucketAclCommand.d.ts +47 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/GetBucketAnalyticsConfigurationCommand.d.ts +51 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/GetBucketCorsCommand.d.ts +47 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/GetBucketEncryptionCommand.d.ts +51 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/GetBucketIntelligentTieringConfigurationCommand.d.ts +51 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/GetBucketInventoryConfigurationCommand.d.ts +51 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/GetBucketLifecycleConfigurationCommand.d.ts +51 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/GetBucketLocationCommand.d.ts +51 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/GetBucketLoggingCommand.d.ts +50 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/GetBucketMetadataTableConfigurationCommand.d.ts +51 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/GetBucketMetricsConfigurationCommand.d.ts +51 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/GetBucketNotificationConfigurationCommand.d.ts +51 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/GetBucketOwnershipControlsCommand.d.ts +51 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/GetBucketPolicyCommand.d.ts +50 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/GetBucketPolicyStatusCommand.d.ts +51 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/GetBucketReplicationCommand.d.ts +51 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/GetBucketRequestPaymentCommand.d.ts +51 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/GetBucketTaggingCommand.d.ts +50 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/GetBucketVersioningCommand.d.ts +51 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/GetBucketWebsiteCommand.d.ts +50 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/GetObjectAclCommand.d.ts +47 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/GetObjectAttributesCommand.d.ts +51 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/GetObjectCommand.d.ts +52 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/GetObjectLegalHoldCommand.d.ts +51 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/GetObjectLockConfigurationCommand.d.ts +51 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/GetObjectRetentionCommand.d.ts +51 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/GetObjectTaggingCommand.d.ts +50 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/GetObjectTorrentCommand.d.ts +58 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/GetPublicAccessBlockCommand.d.ts +51 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/HeadBucketCommand.d.ts +47 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/HeadObjectCommand.d.ts +47 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/ListBucketAnalyticsConfigurationsCommand.d.ts +51 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/ListBucketIntelligentTieringConfigurationsCommand.d.ts +51 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/ListBucketInventoryConfigurationsCommand.d.ts +51 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/ListBucketMetricsConfigurationsCommand.d.ts +51 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/ListBucketsCommand.d.ts +47 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/ListDirectoryBucketsCommand.d.ts +51 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/ListMultipartUploadsCommand.d.ts +51 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/ListObjectVersionsCommand.d.ts +51 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/ListObjectsCommand.d.ts +47 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/ListObjectsV2Command.d.ts +47 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/ListPartsCommand.d.ts +47 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/PutBucketAccelerateConfigurationCommand.d.ts +47 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/PutBucketAclCommand.d.ts +45 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/PutBucketAnalyticsConfigurationCommand.d.ts +47 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/PutBucketCorsCommand.d.ts +45 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/PutBucketEncryptionCommand.d.ts +46 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/PutBucketIntelligentTieringConfigurationCommand.d.ts +47 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/PutBucketInventoryConfigurationCommand.d.ts +47 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/PutBucketLifecycleConfigurationCommand.d.ts +51 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/PutBucketLoggingCommand.d.ts +45 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/PutBucketMetricsConfigurationCommand.d.ts +47 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/PutBucketNotificationConfigurationCommand.d.ts +47 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/PutBucketOwnershipControlsCommand.d.ts +47 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/PutBucketPolicyCommand.d.ts +45 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/PutBucketReplicationCommand.d.ts +46 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/PutBucketRequestPaymentCommand.d.ts +47 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/PutBucketTaggingCommand.d.ts +45 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/PutBucketVersioningCommand.d.ts +46 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/PutBucketWebsiteCommand.d.ts +45 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/PutObjectAclCommand.d.ts +47 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/PutObjectCommand.d.ts +53 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/PutObjectLegalHoldCommand.d.ts +51 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/PutObjectLockConfigurationCommand.d.ts +51 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/PutObjectRetentionCommand.d.ts +51 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/PutObjectTaggingCommand.d.ts +50 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/PutPublicAccessBlockCommand.d.ts +46 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/RestoreObjectCommand.d.ts +47 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/SelectObjectContentCommand.d.ts +51 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/UploadPartCommand.d.ts +53 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/UploadPartCopyCommand.d.ts +50 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/WriteGetObjectResponseCommand.d.ts +54 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/commands/index.d.ts +98 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +94 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/endpoint/endpointResolver.d.ts +8 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/endpoint/ruleset.d.ts +2 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/extensionConfiguration.d.ts +9 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/index.d.ts +10 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/models/S3ServiceException.d.ts +9 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/models/index.d.ts +2 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/models/models_0.d.ts +2074 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/models/models_1.d.ts +742 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/pagination/Interfaces.d.ts +5 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/pagination/ListBucketsPaginator.d.ts +11 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/pagination/ListDirectoryBucketsPaginator.d.ts +11 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/pagination/ListObjectsV2Paginator.d.ts +11 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/pagination/ListPartsPaginator.d.ts +11 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/pagination/index.d.ts +5 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/protocols/Aws_restXml.d.ts +1185 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/runtimeConfig.browser.d.ts +145 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/runtimeConfig.d.ts +147 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/runtimeConfig.native.d.ts +133 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/runtimeConfig.shared.d.ts +36 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/runtimeExtensions.d.ts +11 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/waiters/index.d.ts +4 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/waiters/waitForBucketExists.d.ts +11 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/waiters/waitForBucketNotExists.d.ts +11 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/waiters/waitForObjectExists.d.ts +11 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/ts3.4/waiters/waitForObjectNotExists.d.ts +11 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/waiters/index.d.ts +4 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/waiters/waitForBucketExists.d.ts +14 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/waiters/waitForBucketNotExists.d.ts +14 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/waiters/waitForObjectExists.d.ts +14 -0
- package/dist/node_modules/@aws-sdk/client-s3/dist-types/waiters/waitForObjectNotExists.d.ts +14 -0
- package/dist/node_modules/@aws-sdk/client-s3/package.json +1 -0
- package/dist/node_modules/mime-match/.travis.yml +11 -0
- package/dist/node_modules/mime-match/example.js +17 -0
- package/dist/node_modules/mime-match/index.js +1 -0
- package/dist/node_modules/mime-match/package.json +1 -0
- package/dist/node_modules/mime-match/test.js +45 -0
- package/dist/node_modules/mkdirp/LICENSE +21 -0
- package/dist/node_modules/mkdirp/bin/cmd.js +33 -0
- package/dist/node_modules/mkdirp/bin/usage.txt +12 -0
- package/dist/node_modules/mkdirp/index.js +1 -0
- package/dist/node_modules/mkdirp/package.json +1 -0
- package/dist/node_modules/mkdirp/readme.markdown +100 -0
- package/dist/node_modules/multer-aliyun-oss/index.js +74 -0
- package/dist/node_modules/multer-aliyun-oss/package.json +1 -0
- package/dist/node_modules/multer-cos/LICENSE +24 -0
- package/dist/node_modules/multer-cos/demo/index.js +39 -0
- package/dist/node_modules/multer-cos/demo/myMulter.js +88 -0
- package/dist/node_modules/multer-cos/index.js +220 -0
- package/dist/node_modules/multer-cos/package.json +1 -0
- package/dist/node_modules/multer-s3/.gitattributes +1 -0
- package/dist/node_modules/multer-s3/.travis.yml +6 -0
- package/dist/node_modules/multer-s3/LICENSE +22 -0
- package/dist/node_modules/multer-s3/index.js +5 -0
- package/dist/node_modules/multer-s3/package.json +1 -0
- package/dist/node_modules/multer-s3/test/basic.js +293 -0
- package/dist/node_modules/multer-s3/test/files/a.txt +1 -0
- package/dist/node_modules/multer-s3/test/files/test.svg +3 -0
- package/dist/node_modules/multer-s3/test/files/test2.svg +9 -0
- package/dist/node_modules/multer-s3/test/util/mock-s3.js +17 -0
- package/dist/server/FileModel.d.ts +4 -0
- package/dist/server/FileModel.js +45 -0
- package/dist/server/actions/attachments.d.ts +3 -0
- package/dist/server/actions/attachments.js +183 -0
- package/dist/server/actions/index.d.ts +3 -0
- package/dist/server/actions/index.js +39 -0
- package/dist/server/collections/attachments.d.ts +2 -0
- package/dist/server/collections/attachments.js +87 -0
- package/dist/server/collections/storages.d.ts +2 -0
- package/dist/server/collections/storages.js +85 -0
- package/dist/server/constants.d.ts +7 -0
- package/dist/server/constants.js +45 -0
- package/dist/server/index.d.ts +2 -0
- package/dist/server/index.js +39 -0
- package/dist/server/migrations/20230831160742-fix-attachment-field.d.ts +5 -0
- package/dist/server/migrations/20230831160742-fix-attachment-field.js +62 -0
- package/dist/server/migrations/20231120142523-fix-storage.d.ts +5 -0
- package/dist/server/migrations/20231120142523-fix-storage.js +63 -0
- package/dist/server/migrations/20240306223006-update-target.d.ts +6 -0
- package/dist/server/migrations/20240306223006-update-target.js +45 -0
- package/dist/server/rules/index.d.ts +1 -0
- package/dist/server/rules/index.js +37 -0
- package/dist/server/rules/mimetype.d.ts +1 -0
- package/dist/server/rules/mimetype.js +36 -0
- package/dist/server/server.d.ts +11 -0
- package/dist/server/server.js +130 -0
- package/dist/server/storages/ali-oss.d.ts +18 -0
- package/dist/server/storages/ali-oss.js +55 -0
- package/dist/server/storages/index.d.ts +33 -0
- package/dist/server/storages/index.js +52 -0
- package/dist/server/storages/local.d.ts +16 -0
- package/dist/server/storages/local.js +87 -0
- package/dist/server/storages/s3.d.ts +19 -0
- package/dist/server/storages/s3.js +82 -0
- package/dist/server/storages/tx-cos.d.ts +19 -0
- package/dist/server/storages/tx-cos.js +61 -0
- package/dist/server/utils.d.ts +2 -0
- package/dist/server/utils.js +53 -0
- package/dist/swagger/index.json +81 -0
- package/package.json +46 -0
- package/server.d.ts +2 -0
- package/server.js +1 -0
|
@@ -0,0 +1,3948 @@
|
|
|
1
|
+
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
|
+
import { StreamingBlobTypes } from "@smithy/types";
|
|
3
|
+
import { AccessControlPolicy, BucketVersioningStatus, ChecksumAlgorithm, CORSConfiguration, ErrorDocument, Grant, IndexDocument, IntelligentTieringConfiguration, InventoryConfiguration, LifecycleRule, LoggingEnabled, MetricsConfiguration, NotificationConfiguration, ObjectCannedACL, ObjectLockConfiguration, ObjectLockLegalHold, ObjectLockLegalHoldStatus, ObjectLockMode, ObjectLockRetention, OwnershipControls, Payer, PublicAccessBlockConfiguration, RedirectAllRequestsTo, ReplicationConfiguration, ReplicationStatus, RequestCharged, RequestPayer, RoutingRule, ServerSideEncryption, ServerSideEncryptionConfiguration, StorageClass, Tag, TransitionDefaultMinimumObjectSize } from "./models_0";
|
|
4
|
+
import { S3ServiceException as __BaseException } from "./S3ServiceException";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export interface PutBucketCorsRequest {
|
|
9
|
+
/**
|
|
10
|
+
* <p>Specifies the bucket impacted by the <code>cors</code>configuration.</p>
|
|
11
|
+
* <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
|
|
12
|
+
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
13
|
+
* @public
|
|
14
|
+
*/
|
|
15
|
+
Bucket: string | undefined;
|
|
16
|
+
/**
|
|
17
|
+
* <p>Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more
|
|
18
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html">Enabling
|
|
19
|
+
* Cross-Origin Resource Sharing</a> in the
|
|
20
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
21
|
+
* @public
|
|
22
|
+
*/
|
|
23
|
+
CORSConfiguration: CORSConfiguration | undefined;
|
|
24
|
+
/**
|
|
25
|
+
* <p>The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message
|
|
26
|
+
* integrity check to verify that the request body was not corrupted in transit. For more
|
|
27
|
+
* information, go to <a href="http://www.ietf.org/rfc/rfc1864.txt">RFC
|
|
28
|
+
* 1864.</a>
|
|
29
|
+
* </p>
|
|
30
|
+
* <p>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</p>
|
|
31
|
+
* @public
|
|
32
|
+
*/
|
|
33
|
+
ContentMD5?: string | undefined;
|
|
34
|
+
/**
|
|
35
|
+
* <p>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any
|
|
36
|
+
* additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or
|
|
37
|
+
* <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more
|
|
38
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
|
|
39
|
+
* the <i>Amazon S3 User Guide</i>.</p>
|
|
40
|
+
* <p>If you provide an individual checksum, Amazon S3 ignores any provided
|
|
41
|
+
* <code>ChecksumAlgorithm</code> parameter.</p>
|
|
42
|
+
* @public
|
|
43
|
+
*/
|
|
44
|
+
ChecksumAlgorithm?: ChecksumAlgorithm | undefined;
|
|
45
|
+
/**
|
|
46
|
+
* <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
|
|
47
|
+
* @public
|
|
48
|
+
*/
|
|
49
|
+
ExpectedBucketOwner?: string | undefined;
|
|
50
|
+
}
|
|
51
|
+
/**
|
|
52
|
+
* @public
|
|
53
|
+
*/
|
|
54
|
+
export interface PutBucketEncryptionRequest {
|
|
55
|
+
/**
|
|
56
|
+
* <p>Specifies default encryption for a bucket using server-side encryption with different
|
|
57
|
+
* key options.</p>
|
|
58
|
+
* <p>
|
|
59
|
+
* <b>Directory buckets </b> - When you use this operation with a directory bucket, you must use path-style requests in the format <code>https://s3express-control.<i>region-code</i>.amazonaws.com/<i>bucket-name</i>
|
|
60
|
+
* </code>. Virtual-hosted-style requests aren't supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must also follow the format <code>
|
|
61
|
+
* <i>bucket-base-name</i>--<i>zone-id</i>--x-s3</code> (for example, <code>
|
|
62
|
+
* <i>DOC-EXAMPLE-BUCKET</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming restrictions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html">Directory bucket naming rules</a> in the <i>Amazon S3 User Guide</i>
|
|
63
|
+
* </p>
|
|
64
|
+
* <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
|
|
65
|
+
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
66
|
+
* @public
|
|
67
|
+
*/
|
|
68
|
+
Bucket: string | undefined;
|
|
69
|
+
/**
|
|
70
|
+
* <p>The base64-encoded 128-bit MD5 digest of the server-side encryption
|
|
71
|
+
* configuration.</p>
|
|
72
|
+
* <p>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</p>
|
|
73
|
+
* <note>
|
|
74
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
75
|
+
* </note>
|
|
76
|
+
* @public
|
|
77
|
+
*/
|
|
78
|
+
ContentMD5?: string | undefined;
|
|
79
|
+
/**
|
|
80
|
+
* <p>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any
|
|
81
|
+
* additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or
|
|
82
|
+
* <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more
|
|
83
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
|
|
84
|
+
* the <i>Amazon S3 User Guide</i>.</p>
|
|
85
|
+
* <p>If you provide an individual checksum, Amazon S3 ignores any provided
|
|
86
|
+
* <code>ChecksumAlgorithm</code> parameter.</p>
|
|
87
|
+
* <note>
|
|
88
|
+
* <p>For directory buckets, when you use Amazon Web Services SDKs, <code>CRC32</code> is the default checksum algorithm that's used for performance.</p>
|
|
89
|
+
* </note>
|
|
90
|
+
* @public
|
|
91
|
+
*/
|
|
92
|
+
ChecksumAlgorithm?: ChecksumAlgorithm | undefined;
|
|
93
|
+
/**
|
|
94
|
+
* <p>Specifies the default server-side-encryption configuration.</p>
|
|
95
|
+
* @public
|
|
96
|
+
*/
|
|
97
|
+
ServerSideEncryptionConfiguration: ServerSideEncryptionConfiguration | undefined;
|
|
98
|
+
/**
|
|
99
|
+
* <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
|
|
100
|
+
* <note>
|
|
101
|
+
* <p>For directory buckets, this header is not supported in this API operation. If you specify this header, the request fails with the HTTP status code
|
|
102
|
+
* <code>501 Not Implemented</code>.</p>
|
|
103
|
+
* </note>
|
|
104
|
+
* @public
|
|
105
|
+
*/
|
|
106
|
+
ExpectedBucketOwner?: string | undefined;
|
|
107
|
+
}
|
|
108
|
+
/**
|
|
109
|
+
* @public
|
|
110
|
+
*/
|
|
111
|
+
export interface PutBucketIntelligentTieringConfigurationRequest {
|
|
112
|
+
/**
|
|
113
|
+
* <p>The name of the Amazon S3 bucket whose configuration you want to modify or retrieve.</p>
|
|
114
|
+
* <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
|
|
115
|
+
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
116
|
+
* @public
|
|
117
|
+
*/
|
|
118
|
+
Bucket: string | undefined;
|
|
119
|
+
/**
|
|
120
|
+
* <p>The ID used to identify the S3 Intelligent-Tiering configuration.</p>
|
|
121
|
+
* @public
|
|
122
|
+
*/
|
|
123
|
+
Id: string | undefined;
|
|
124
|
+
/**
|
|
125
|
+
* <p>Container for S3 Intelligent-Tiering configuration.</p>
|
|
126
|
+
* @public
|
|
127
|
+
*/
|
|
128
|
+
IntelligentTieringConfiguration: IntelligentTieringConfiguration | undefined;
|
|
129
|
+
}
|
|
130
|
+
/**
|
|
131
|
+
* @public
|
|
132
|
+
*/
|
|
133
|
+
export interface PutBucketInventoryConfigurationRequest {
|
|
134
|
+
/**
|
|
135
|
+
* <p>The name of the bucket where the inventory configuration will be stored.</p>
|
|
136
|
+
* <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
|
|
137
|
+
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
138
|
+
* @public
|
|
139
|
+
*/
|
|
140
|
+
Bucket: string | undefined;
|
|
141
|
+
/**
|
|
142
|
+
* <p>The ID used to identify the inventory configuration.</p>
|
|
143
|
+
* @public
|
|
144
|
+
*/
|
|
145
|
+
Id: string | undefined;
|
|
146
|
+
/**
|
|
147
|
+
* <p>Specifies the inventory configuration.</p>
|
|
148
|
+
* @public
|
|
149
|
+
*/
|
|
150
|
+
InventoryConfiguration: InventoryConfiguration | undefined;
|
|
151
|
+
/**
|
|
152
|
+
* <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
|
|
153
|
+
* @public
|
|
154
|
+
*/
|
|
155
|
+
ExpectedBucketOwner?: string | undefined;
|
|
156
|
+
}
|
|
157
|
+
/**
|
|
158
|
+
* @public
|
|
159
|
+
*/
|
|
160
|
+
export interface PutBucketLifecycleConfigurationOutput {
|
|
161
|
+
/**
|
|
162
|
+
* <p>Indicates which default minimum object size behavior is applied to the lifecycle
|
|
163
|
+
* configuration.</p>
|
|
164
|
+
* <note>
|
|
165
|
+
* <p>This parameter applies to general purpose buckets only. It is not supported for
|
|
166
|
+
* directory bucket lifecycle configurations.</p>
|
|
167
|
+
* </note>
|
|
168
|
+
* <ul>
|
|
169
|
+
* <li>
|
|
170
|
+
* <p>
|
|
171
|
+
* <code>all_storage_classes_128K</code> - Objects smaller than 128 KB will not
|
|
172
|
+
* transition to any storage class by default. </p>
|
|
173
|
+
* </li>
|
|
174
|
+
* <li>
|
|
175
|
+
* <p>
|
|
176
|
+
* <code>varies_by_storage_class</code> - Objects smaller than 128 KB will
|
|
177
|
+
* transition to Glacier Flexible Retrieval or Glacier Deep Archive storage classes. By
|
|
178
|
+
* default, all other storage classes will prevent transitions smaller than 128 KB.
|
|
179
|
+
* </p>
|
|
180
|
+
* </li>
|
|
181
|
+
* </ul>
|
|
182
|
+
* <p>To customize the minimum object size for any transition you can add a filter that
|
|
183
|
+
* specifies a custom <code>ObjectSizeGreaterThan</code> or <code>ObjectSizeLessThan</code> in
|
|
184
|
+
* the body of your transition rule. Custom filters always take precedence over the default
|
|
185
|
+
* transition behavior.</p>
|
|
186
|
+
* @public
|
|
187
|
+
*/
|
|
188
|
+
TransitionDefaultMinimumObjectSize?: TransitionDefaultMinimumObjectSize | undefined;
|
|
189
|
+
}
|
|
190
|
+
/**
|
|
191
|
+
* <p>Specifies the lifecycle configuration for objects in an Amazon S3 bucket. For more
|
|
192
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html">Object Lifecycle Management</a>
|
|
193
|
+
* in the <i>Amazon S3 User Guide</i>.</p>
|
|
194
|
+
* @public
|
|
195
|
+
*/
|
|
196
|
+
export interface BucketLifecycleConfiguration {
|
|
197
|
+
/**
|
|
198
|
+
* <p>A lifecycle rule for individual objects in an Amazon S3 bucket.</p>
|
|
199
|
+
* @public
|
|
200
|
+
*/
|
|
201
|
+
Rules: LifecycleRule[] | undefined;
|
|
202
|
+
}
|
|
203
|
+
/**
|
|
204
|
+
* @public
|
|
205
|
+
*/
|
|
206
|
+
export interface PutBucketLifecycleConfigurationRequest {
|
|
207
|
+
/**
|
|
208
|
+
* <p>The name of the bucket for which to set the configuration.</p>
|
|
209
|
+
* <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
|
|
210
|
+
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
211
|
+
* @public
|
|
212
|
+
*/
|
|
213
|
+
Bucket: string | undefined;
|
|
214
|
+
/**
|
|
215
|
+
* <p>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any
|
|
216
|
+
* additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or
|
|
217
|
+
* <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more
|
|
218
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
|
|
219
|
+
* the <i>Amazon S3 User Guide</i>.</p>
|
|
220
|
+
* <p>If you provide an individual checksum, Amazon S3 ignores any provided
|
|
221
|
+
* <code>ChecksumAlgorithm</code> parameter.</p>
|
|
222
|
+
* @public
|
|
223
|
+
*/
|
|
224
|
+
ChecksumAlgorithm?: ChecksumAlgorithm | undefined;
|
|
225
|
+
/**
|
|
226
|
+
* <p>Container for lifecycle rules. You can add as many as 1,000 rules.</p>
|
|
227
|
+
* @public
|
|
228
|
+
*/
|
|
229
|
+
LifecycleConfiguration?: BucketLifecycleConfiguration | undefined;
|
|
230
|
+
/**
|
|
231
|
+
* <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
|
|
232
|
+
* <note>
|
|
233
|
+
* <p>This parameter applies to general purpose buckets only. It is not supported for
|
|
234
|
+
* directory bucket lifecycle configurations.</p>
|
|
235
|
+
* </note>
|
|
236
|
+
* @public
|
|
237
|
+
*/
|
|
238
|
+
ExpectedBucketOwner?: string | undefined;
|
|
239
|
+
/**
|
|
240
|
+
* <p>Indicates which default minimum object size behavior is applied to the lifecycle
|
|
241
|
+
* configuration.</p>
|
|
242
|
+
* <note>
|
|
243
|
+
* <p>This parameter applies to general purpose buckets only. It is not supported for
|
|
244
|
+
* directory bucket lifecycle configurations.</p>
|
|
245
|
+
* </note>
|
|
246
|
+
* <ul>
|
|
247
|
+
* <li>
|
|
248
|
+
* <p>
|
|
249
|
+
* <code>all_storage_classes_128K</code> - Objects smaller than 128 KB will not
|
|
250
|
+
* transition to any storage class by default. </p>
|
|
251
|
+
* </li>
|
|
252
|
+
* <li>
|
|
253
|
+
* <p>
|
|
254
|
+
* <code>varies_by_storage_class</code> - Objects smaller than 128 KB will
|
|
255
|
+
* transition to Glacier Flexible Retrieval or Glacier Deep Archive storage classes. By
|
|
256
|
+
* default, all other storage classes will prevent transitions smaller than 128 KB.
|
|
257
|
+
* </p>
|
|
258
|
+
* </li>
|
|
259
|
+
* </ul>
|
|
260
|
+
* <p>To customize the minimum object size for any transition you can add a filter that
|
|
261
|
+
* specifies a custom <code>ObjectSizeGreaterThan</code> or <code>ObjectSizeLessThan</code> in
|
|
262
|
+
* the body of your transition rule. Custom filters always take precedence over the default
|
|
263
|
+
* transition behavior.</p>
|
|
264
|
+
* @public
|
|
265
|
+
*/
|
|
266
|
+
TransitionDefaultMinimumObjectSize?: TransitionDefaultMinimumObjectSize | undefined;
|
|
267
|
+
}
|
|
268
|
+
/**
|
|
269
|
+
* <p>Container for logging status information.</p>
|
|
270
|
+
* @public
|
|
271
|
+
*/
|
|
272
|
+
export interface BucketLoggingStatus {
|
|
273
|
+
/**
|
|
274
|
+
* <p>Describes where logs are stored and the prefix that Amazon S3 assigns to all log object keys
|
|
275
|
+
* for a bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTlogging.html">PUT Bucket logging</a> in the
|
|
276
|
+
* <i>Amazon S3 API Reference</i>.</p>
|
|
277
|
+
* @public
|
|
278
|
+
*/
|
|
279
|
+
LoggingEnabled?: LoggingEnabled | undefined;
|
|
280
|
+
}
|
|
281
|
+
/**
|
|
282
|
+
* @public
|
|
283
|
+
*/
|
|
284
|
+
export interface PutBucketLoggingRequest {
|
|
285
|
+
/**
|
|
286
|
+
* <p>The name of the bucket for which to set the logging parameters.</p>
|
|
287
|
+
* <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
|
|
288
|
+
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
289
|
+
* @public
|
|
290
|
+
*/
|
|
291
|
+
Bucket: string | undefined;
|
|
292
|
+
/**
|
|
293
|
+
* <p>Container for logging status information.</p>
|
|
294
|
+
* @public
|
|
295
|
+
*/
|
|
296
|
+
BucketLoggingStatus: BucketLoggingStatus | undefined;
|
|
297
|
+
/**
|
|
298
|
+
* <p>The MD5 hash of the <code>PutBucketLogging</code> request body.</p>
|
|
299
|
+
* <p>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</p>
|
|
300
|
+
* @public
|
|
301
|
+
*/
|
|
302
|
+
ContentMD5?: string | undefined;
|
|
303
|
+
/**
|
|
304
|
+
* <p>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any
|
|
305
|
+
* additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or
|
|
306
|
+
* <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more
|
|
307
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
|
|
308
|
+
* the <i>Amazon S3 User Guide</i>.</p>
|
|
309
|
+
* <p>If you provide an individual checksum, Amazon S3 ignores any provided
|
|
310
|
+
* <code>ChecksumAlgorithm</code> parameter.</p>
|
|
311
|
+
* @public
|
|
312
|
+
*/
|
|
313
|
+
ChecksumAlgorithm?: ChecksumAlgorithm | undefined;
|
|
314
|
+
/**
|
|
315
|
+
* <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
|
|
316
|
+
* @public
|
|
317
|
+
*/
|
|
318
|
+
ExpectedBucketOwner?: string | undefined;
|
|
319
|
+
}
|
|
320
|
+
/**
|
|
321
|
+
* @public
|
|
322
|
+
*/
|
|
323
|
+
export interface PutBucketMetricsConfigurationRequest {
|
|
324
|
+
/**
|
|
325
|
+
* <p>The name of the bucket for which the metrics configuration is set.</p>
|
|
326
|
+
* <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
|
|
327
|
+
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
328
|
+
* @public
|
|
329
|
+
*/
|
|
330
|
+
Bucket: string | undefined;
|
|
331
|
+
/**
|
|
332
|
+
* <p>The ID used to identify the metrics configuration. The ID has a 64 character limit and
|
|
333
|
+
* can only contain letters, numbers, periods, dashes, and underscores.</p>
|
|
334
|
+
* @public
|
|
335
|
+
*/
|
|
336
|
+
Id: string | undefined;
|
|
337
|
+
/**
|
|
338
|
+
* <p>Specifies the metrics configuration.</p>
|
|
339
|
+
* @public
|
|
340
|
+
*/
|
|
341
|
+
MetricsConfiguration: MetricsConfiguration | undefined;
|
|
342
|
+
/**
|
|
343
|
+
* <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
|
|
344
|
+
* @public
|
|
345
|
+
*/
|
|
346
|
+
ExpectedBucketOwner?: string | undefined;
|
|
347
|
+
}
|
|
348
|
+
/**
|
|
349
|
+
* @public
|
|
350
|
+
*/
|
|
351
|
+
export interface PutBucketNotificationConfigurationRequest {
|
|
352
|
+
/**
|
|
353
|
+
* <p>The name of the bucket.</p>
|
|
354
|
+
* <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
|
|
355
|
+
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
356
|
+
* @public
|
|
357
|
+
*/
|
|
358
|
+
Bucket: string | undefined;
|
|
359
|
+
/**
|
|
360
|
+
* <p>A container for specifying the notification configuration of the bucket. If this element
|
|
361
|
+
* is empty, notifications are turned off for the bucket.</p>
|
|
362
|
+
* @public
|
|
363
|
+
*/
|
|
364
|
+
NotificationConfiguration: NotificationConfiguration | undefined;
|
|
365
|
+
/**
|
|
366
|
+
* <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
|
|
367
|
+
* @public
|
|
368
|
+
*/
|
|
369
|
+
ExpectedBucketOwner?: string | undefined;
|
|
370
|
+
/**
|
|
371
|
+
* <p>Skips validation of Amazon SQS, Amazon SNS, and Lambda
|
|
372
|
+
* destinations. True or false value.</p>
|
|
373
|
+
* @public
|
|
374
|
+
*/
|
|
375
|
+
SkipDestinationValidation?: boolean | undefined;
|
|
376
|
+
}
|
|
377
|
+
/**
|
|
378
|
+
* @public
|
|
379
|
+
*/
|
|
380
|
+
export interface PutBucketOwnershipControlsRequest {
|
|
381
|
+
/**
|
|
382
|
+
* <p>The name of the Amazon S3 bucket whose <code>OwnershipControls</code> you want to set.</p>
|
|
383
|
+
* <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
|
|
384
|
+
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
385
|
+
* @public
|
|
386
|
+
*/
|
|
387
|
+
Bucket: string | undefined;
|
|
388
|
+
/**
|
|
389
|
+
* <p>The MD5 hash of the <code>OwnershipControls</code> request body. </p>
|
|
390
|
+
* <p>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</p>
|
|
391
|
+
* @public
|
|
392
|
+
*/
|
|
393
|
+
ContentMD5?: string | undefined;
|
|
394
|
+
/**
|
|
395
|
+
* <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
|
|
396
|
+
* @public
|
|
397
|
+
*/
|
|
398
|
+
ExpectedBucketOwner?: string | undefined;
|
|
399
|
+
/**
|
|
400
|
+
* <p>The <code>OwnershipControls</code> (BucketOwnerEnforced, BucketOwnerPreferred, or
|
|
401
|
+
* ObjectWriter) that you want to apply to this Amazon S3 bucket.</p>
|
|
402
|
+
* @public
|
|
403
|
+
*/
|
|
404
|
+
OwnershipControls: OwnershipControls | undefined;
|
|
405
|
+
}
|
|
406
|
+
/**
|
|
407
|
+
* @public
|
|
408
|
+
*/
|
|
409
|
+
export interface PutBucketPolicyRequest {
|
|
410
|
+
/**
|
|
411
|
+
* <p>The name of the bucket.</p>
|
|
412
|
+
* <p>
|
|
413
|
+
* <b>Directory buckets </b> - When you use this operation with a directory bucket, you must use path-style requests in the format <code>https://s3express-control.<i>region-code</i>.amazonaws.com/<i>bucket-name</i>
|
|
414
|
+
* </code>. Virtual-hosted-style requests aren't supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must also follow the format <code>
|
|
415
|
+
* <i>bucket-base-name</i>--<i>zone-id</i>--x-s3</code> (for example, <code>
|
|
416
|
+
* <i>DOC-EXAMPLE-BUCKET</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming restrictions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html">Directory bucket naming rules</a> in the <i>Amazon S3 User Guide</i>
|
|
417
|
+
* </p>
|
|
418
|
+
* <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
|
|
419
|
+
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
420
|
+
* @public
|
|
421
|
+
*/
|
|
422
|
+
Bucket: string | undefined;
|
|
423
|
+
/**
|
|
424
|
+
* <p>The MD5 hash of the request body.</p>
|
|
425
|
+
* <p>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</p>
|
|
426
|
+
* <note>
|
|
427
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
428
|
+
* </note>
|
|
429
|
+
* @public
|
|
430
|
+
*/
|
|
431
|
+
ContentMD5?: string | undefined;
|
|
432
|
+
/**
|
|
433
|
+
* <p>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any
|
|
434
|
+
* additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum-<i>algorithm</i>
|
|
435
|
+
* </code> or
|
|
436
|
+
* <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>.</p>
|
|
437
|
+
* <p>For the <code>x-amz-checksum-<i>algorithm</i>
|
|
438
|
+
* </code> header, replace <code>
|
|
439
|
+
* <i>algorithm</i>
|
|
440
|
+
* </code> with the supported algorithm from the following list: </p>
|
|
441
|
+
* <ul>
|
|
442
|
+
* <li>
|
|
443
|
+
* <p>
|
|
444
|
+
* <code>CRC32</code>
|
|
445
|
+
* </p>
|
|
446
|
+
* </li>
|
|
447
|
+
* <li>
|
|
448
|
+
* <p>
|
|
449
|
+
* <code>CRC32C</code>
|
|
450
|
+
* </p>
|
|
451
|
+
* </li>
|
|
452
|
+
* <li>
|
|
453
|
+
* <p>
|
|
454
|
+
* <code>SHA1</code>
|
|
455
|
+
* </p>
|
|
456
|
+
* </li>
|
|
457
|
+
* <li>
|
|
458
|
+
* <p>
|
|
459
|
+
* <code>SHA256</code>
|
|
460
|
+
* </p>
|
|
461
|
+
* </li>
|
|
462
|
+
* </ul>
|
|
463
|
+
* <p>For more
|
|
464
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
|
|
465
|
+
* the <i>Amazon S3 User Guide</i>.</p>
|
|
466
|
+
* <p>If the individual checksum value you provide through <code>x-amz-checksum-<i>algorithm</i>
|
|
467
|
+
* </code> doesn't match the checksum algorithm you set through <code>x-amz-sdk-checksum-algorithm</code>, Amazon S3 ignores any provided
|
|
468
|
+
* <code>ChecksumAlgorithm</code> parameter and uses the checksum algorithm that matches the provided value in <code>x-amz-checksum-<i>algorithm</i>
|
|
469
|
+
* </code>.</p>
|
|
470
|
+
* <note>
|
|
471
|
+
* <p>For directory buckets, when you use Amazon Web Services SDKs, <code>CRC32</code> is the default checksum algorithm that's used for performance.</p>
|
|
472
|
+
* </note>
|
|
473
|
+
* @public
|
|
474
|
+
*/
|
|
475
|
+
ChecksumAlgorithm?: ChecksumAlgorithm | undefined;
|
|
476
|
+
/**
|
|
477
|
+
* <p>Set this parameter to true to confirm that you want to remove your permissions to change
|
|
478
|
+
* this bucket policy in the future.</p>
|
|
479
|
+
* <note>
|
|
480
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
481
|
+
* </note>
|
|
482
|
+
* @public
|
|
483
|
+
*/
|
|
484
|
+
ConfirmRemoveSelfBucketAccess?: boolean | undefined;
|
|
485
|
+
/**
|
|
486
|
+
* <p>The bucket policy as a JSON document.</p>
|
|
487
|
+
* <p>For directory buckets, the only IAM action supported in the bucket policy is
|
|
488
|
+
* <code>s3express:CreateSession</code>.</p>
|
|
489
|
+
* @public
|
|
490
|
+
*/
|
|
491
|
+
Policy: string | undefined;
|
|
492
|
+
/**
|
|
493
|
+
* <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
|
|
494
|
+
* <note>
|
|
495
|
+
* <p>For directory buckets, this header is not supported in this API operation. If you specify this header, the request fails with the HTTP status code
|
|
496
|
+
* <code>501 Not Implemented</code>.</p>
|
|
497
|
+
* </note>
|
|
498
|
+
* @public
|
|
499
|
+
*/
|
|
500
|
+
ExpectedBucketOwner?: string | undefined;
|
|
501
|
+
}
|
|
502
|
+
/**
|
|
503
|
+
* @public
|
|
504
|
+
*/
|
|
505
|
+
export interface PutBucketReplicationRequest {
|
|
506
|
+
/**
|
|
507
|
+
* <p>The name of the bucket</p>
|
|
508
|
+
* <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
|
|
509
|
+
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
510
|
+
* @public
|
|
511
|
+
*/
|
|
512
|
+
Bucket: string | undefined;
|
|
513
|
+
/**
|
|
514
|
+
* <p>The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message
|
|
515
|
+
* integrity check to verify that the request body was not corrupted in transit. For more
|
|
516
|
+
* information, see <a href="http://www.ietf.org/rfc/rfc1864.txt">RFC 1864</a>.</p>
|
|
517
|
+
* <p>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</p>
|
|
518
|
+
* @public
|
|
519
|
+
*/
|
|
520
|
+
ContentMD5?: string | undefined;
|
|
521
|
+
/**
|
|
522
|
+
* <p>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any
|
|
523
|
+
* additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or
|
|
524
|
+
* <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more
|
|
525
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
|
|
526
|
+
* the <i>Amazon S3 User Guide</i>.</p>
|
|
527
|
+
* <p>If you provide an individual checksum, Amazon S3 ignores any provided
|
|
528
|
+
* <code>ChecksumAlgorithm</code> parameter.</p>
|
|
529
|
+
* @public
|
|
530
|
+
*/
|
|
531
|
+
ChecksumAlgorithm?: ChecksumAlgorithm | undefined;
|
|
532
|
+
/**
|
|
533
|
+
* <p>A container for replication rules. You can add up to 1,000 rules. The maximum size of a
|
|
534
|
+
* replication configuration is 2 MB.</p>
|
|
535
|
+
* @public
|
|
536
|
+
*/
|
|
537
|
+
ReplicationConfiguration: ReplicationConfiguration | undefined;
|
|
538
|
+
/**
|
|
539
|
+
* <p>A token to allow Object Lock to be enabled for an existing bucket.</p>
|
|
540
|
+
* @public
|
|
541
|
+
*/
|
|
542
|
+
Token?: string | undefined;
|
|
543
|
+
/**
|
|
544
|
+
* <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
|
|
545
|
+
* @public
|
|
546
|
+
*/
|
|
547
|
+
ExpectedBucketOwner?: string | undefined;
|
|
548
|
+
}
|
|
549
|
+
/**
|
|
550
|
+
* <p>Container for Payer.</p>
|
|
551
|
+
* @public
|
|
552
|
+
*/
|
|
553
|
+
export interface RequestPaymentConfiguration {
|
|
554
|
+
/**
|
|
555
|
+
* <p>Specifies who pays for the download and request fees.</p>
|
|
556
|
+
* @public
|
|
557
|
+
*/
|
|
558
|
+
Payer: Payer | undefined;
|
|
559
|
+
}
|
|
560
|
+
/**
|
|
561
|
+
* @public
|
|
562
|
+
*/
|
|
563
|
+
export interface PutBucketRequestPaymentRequest {
|
|
564
|
+
/**
|
|
565
|
+
* <p>The bucket name.</p>
|
|
566
|
+
* <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
|
|
567
|
+
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
568
|
+
* @public
|
|
569
|
+
*/
|
|
570
|
+
Bucket: string | undefined;
|
|
571
|
+
/**
|
|
572
|
+
* <p>The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message
|
|
573
|
+
* integrity check to verify that the request body was not corrupted in transit. For more
|
|
574
|
+
* information, see <a href="http://www.ietf.org/rfc/rfc1864.txt">RFC 1864</a>.</p>
|
|
575
|
+
* <p>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</p>
|
|
576
|
+
* @public
|
|
577
|
+
*/
|
|
578
|
+
ContentMD5?: string | undefined;
|
|
579
|
+
/**
|
|
580
|
+
* <p>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any
|
|
581
|
+
* additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or
|
|
582
|
+
* <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more
|
|
583
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
|
|
584
|
+
* the <i>Amazon S3 User Guide</i>.</p>
|
|
585
|
+
* <p>If you provide an individual checksum, Amazon S3 ignores any provided
|
|
586
|
+
* <code>ChecksumAlgorithm</code> parameter.</p>
|
|
587
|
+
* @public
|
|
588
|
+
*/
|
|
589
|
+
ChecksumAlgorithm?: ChecksumAlgorithm | undefined;
|
|
590
|
+
/**
|
|
591
|
+
* <p>Container for Payer.</p>
|
|
592
|
+
* @public
|
|
593
|
+
*/
|
|
594
|
+
RequestPaymentConfiguration: RequestPaymentConfiguration | undefined;
|
|
595
|
+
/**
|
|
596
|
+
* <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
|
|
597
|
+
* @public
|
|
598
|
+
*/
|
|
599
|
+
ExpectedBucketOwner?: string | undefined;
|
|
600
|
+
}
|
|
601
|
+
/**
|
|
602
|
+
* <p>Container for <code>TagSet</code> elements.</p>
|
|
603
|
+
* @public
|
|
604
|
+
*/
|
|
605
|
+
export interface Tagging {
|
|
606
|
+
/**
|
|
607
|
+
* <p>A collection for a set of tags</p>
|
|
608
|
+
* @public
|
|
609
|
+
*/
|
|
610
|
+
TagSet: Tag[] | undefined;
|
|
611
|
+
}
|
|
612
|
+
/**
|
|
613
|
+
* @public
|
|
614
|
+
*/
|
|
615
|
+
export interface PutBucketTaggingRequest {
|
|
616
|
+
/**
|
|
617
|
+
* <p>The bucket name.</p>
|
|
618
|
+
* <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
|
|
619
|
+
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
620
|
+
* @public
|
|
621
|
+
*/
|
|
622
|
+
Bucket: string | undefined;
|
|
623
|
+
/**
|
|
624
|
+
* <p>The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message
|
|
625
|
+
* integrity check to verify that the request body was not corrupted in transit. For more
|
|
626
|
+
* information, see <a href="http://www.ietf.org/rfc/rfc1864.txt">RFC 1864</a>.</p>
|
|
627
|
+
* <p>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</p>
|
|
628
|
+
* @public
|
|
629
|
+
*/
|
|
630
|
+
ContentMD5?: string | undefined;
|
|
631
|
+
/**
|
|
632
|
+
* <p>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any
|
|
633
|
+
* additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or
|
|
634
|
+
* <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more
|
|
635
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
|
|
636
|
+
* the <i>Amazon S3 User Guide</i>.</p>
|
|
637
|
+
* <p>If you provide an individual checksum, Amazon S3 ignores any provided
|
|
638
|
+
* <code>ChecksumAlgorithm</code> parameter.</p>
|
|
639
|
+
* @public
|
|
640
|
+
*/
|
|
641
|
+
ChecksumAlgorithm?: ChecksumAlgorithm | undefined;
|
|
642
|
+
/**
|
|
643
|
+
* <p>Container for the <code>TagSet</code> and <code>Tag</code> elements.</p>
|
|
644
|
+
* @public
|
|
645
|
+
*/
|
|
646
|
+
Tagging: Tagging | undefined;
|
|
647
|
+
/**
|
|
648
|
+
* <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
|
|
649
|
+
* @public
|
|
650
|
+
*/
|
|
651
|
+
ExpectedBucketOwner?: string | undefined;
|
|
652
|
+
}
|
|
653
|
+
/**
|
|
654
|
+
* @public
|
|
655
|
+
* @enum
|
|
656
|
+
*/
|
|
657
|
+
export declare const MFADelete: {
|
|
658
|
+
readonly Disabled: "Disabled";
|
|
659
|
+
readonly Enabled: "Enabled";
|
|
660
|
+
};
|
|
661
|
+
/**
|
|
662
|
+
* @public
|
|
663
|
+
*/
|
|
664
|
+
export type MFADelete = (typeof MFADelete)[keyof typeof MFADelete];
|
|
665
|
+
/**
|
|
666
|
+
* <p>Describes the versioning state of an Amazon S3 bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTVersioningStatus.html">PUT
|
|
667
|
+
* Bucket versioning</a> in the <i>Amazon S3 API Reference</i>.</p>
|
|
668
|
+
* @public
|
|
669
|
+
*/
|
|
670
|
+
export interface VersioningConfiguration {
|
|
671
|
+
/**
|
|
672
|
+
* <p>Specifies whether MFA delete is enabled in the bucket versioning configuration. This
|
|
673
|
+
* element is only returned if the bucket has been configured with MFA delete. If the bucket
|
|
674
|
+
* has never been so configured, this element is not returned.</p>
|
|
675
|
+
* @public
|
|
676
|
+
*/
|
|
677
|
+
MFADelete?: MFADelete | undefined;
|
|
678
|
+
/**
|
|
679
|
+
* <p>The versioning state of the bucket.</p>
|
|
680
|
+
* @public
|
|
681
|
+
*/
|
|
682
|
+
Status?: BucketVersioningStatus | undefined;
|
|
683
|
+
}
|
|
684
|
+
/**
|
|
685
|
+
* @public
|
|
686
|
+
*/
|
|
687
|
+
export interface PutBucketVersioningRequest {
|
|
688
|
+
/**
|
|
689
|
+
* <p>The bucket name.</p>
|
|
690
|
+
* <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
|
|
691
|
+
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
692
|
+
* @public
|
|
693
|
+
*/
|
|
694
|
+
Bucket: string | undefined;
|
|
695
|
+
/**
|
|
696
|
+
* <p>>The base64-encoded 128-bit MD5 digest of the data. You must use this header as a
|
|
697
|
+
* message integrity check to verify that the request body was not corrupted in transit. For
|
|
698
|
+
* more information, see <a href="http://www.ietf.org/rfc/rfc1864.txt">RFC
|
|
699
|
+
* 1864</a>.</p>
|
|
700
|
+
* <p>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</p>
|
|
701
|
+
* @public
|
|
702
|
+
*/
|
|
703
|
+
ContentMD5?: string | undefined;
|
|
704
|
+
/**
|
|
705
|
+
* <p>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any
|
|
706
|
+
* additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or
|
|
707
|
+
* <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more
|
|
708
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
|
|
709
|
+
* the <i>Amazon S3 User Guide</i>.</p>
|
|
710
|
+
* <p>If you provide an individual checksum, Amazon S3 ignores any provided
|
|
711
|
+
* <code>ChecksumAlgorithm</code> parameter.</p>
|
|
712
|
+
* @public
|
|
713
|
+
*/
|
|
714
|
+
ChecksumAlgorithm?: ChecksumAlgorithm | undefined;
|
|
715
|
+
/**
|
|
716
|
+
* <p>The concatenation of the authentication device's serial number, a space, and the value
|
|
717
|
+
* that is displayed on your authentication device.</p>
|
|
718
|
+
* @public
|
|
719
|
+
*/
|
|
720
|
+
MFA?: string | undefined;
|
|
721
|
+
/**
|
|
722
|
+
* <p>Container for setting the versioning state.</p>
|
|
723
|
+
* @public
|
|
724
|
+
*/
|
|
725
|
+
VersioningConfiguration: VersioningConfiguration | undefined;
|
|
726
|
+
/**
|
|
727
|
+
* <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
|
|
728
|
+
* @public
|
|
729
|
+
*/
|
|
730
|
+
ExpectedBucketOwner?: string | undefined;
|
|
731
|
+
}
|
|
732
|
+
/**
|
|
733
|
+
* <p>Specifies website configuration parameters for an Amazon S3 bucket.</p>
|
|
734
|
+
* @public
|
|
735
|
+
*/
|
|
736
|
+
export interface WebsiteConfiguration {
|
|
737
|
+
/**
|
|
738
|
+
* <p>The name of the error document for the website.</p>
|
|
739
|
+
* @public
|
|
740
|
+
*/
|
|
741
|
+
ErrorDocument?: ErrorDocument | undefined;
|
|
742
|
+
/**
|
|
743
|
+
* <p>The name of the index document for the website.</p>
|
|
744
|
+
* @public
|
|
745
|
+
*/
|
|
746
|
+
IndexDocument?: IndexDocument | undefined;
|
|
747
|
+
/**
|
|
748
|
+
* <p>The redirect behavior for every request to this bucket's website endpoint.</p>
|
|
749
|
+
* <important>
|
|
750
|
+
* <p>If you specify this property, you can't specify any other property.</p>
|
|
751
|
+
* </important>
|
|
752
|
+
* @public
|
|
753
|
+
*/
|
|
754
|
+
RedirectAllRequestsTo?: RedirectAllRequestsTo | undefined;
|
|
755
|
+
/**
|
|
756
|
+
* <p>Rules that define when a redirect is applied and the redirect behavior.</p>
|
|
757
|
+
* @public
|
|
758
|
+
*/
|
|
759
|
+
RoutingRules?: RoutingRule[] | undefined;
|
|
760
|
+
}
|
|
761
|
+
/**
|
|
762
|
+
* @public
|
|
763
|
+
*/
|
|
764
|
+
export interface PutBucketWebsiteRequest {
|
|
765
|
+
/**
|
|
766
|
+
* <p>The bucket name.</p>
|
|
767
|
+
* <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
|
|
768
|
+
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
769
|
+
* @public
|
|
770
|
+
*/
|
|
771
|
+
Bucket: string | undefined;
|
|
772
|
+
/**
|
|
773
|
+
* <p>The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message
|
|
774
|
+
* integrity check to verify that the request body was not corrupted in transit. For more
|
|
775
|
+
* information, see <a href="http://www.ietf.org/rfc/rfc1864.txt">RFC 1864</a>.</p>
|
|
776
|
+
* <p>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</p>
|
|
777
|
+
* @public
|
|
778
|
+
*/
|
|
779
|
+
ContentMD5?: string | undefined;
|
|
780
|
+
/**
|
|
781
|
+
* <p>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any
|
|
782
|
+
* additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or
|
|
783
|
+
* <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more
|
|
784
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
|
|
785
|
+
* the <i>Amazon S3 User Guide</i>.</p>
|
|
786
|
+
* <p>If you provide an individual checksum, Amazon S3 ignores any provided
|
|
787
|
+
* <code>ChecksumAlgorithm</code> parameter.</p>
|
|
788
|
+
* @public
|
|
789
|
+
*/
|
|
790
|
+
ChecksumAlgorithm?: ChecksumAlgorithm | undefined;
|
|
791
|
+
/**
|
|
792
|
+
* <p>Container for the request.</p>
|
|
793
|
+
* @public
|
|
794
|
+
*/
|
|
795
|
+
WebsiteConfiguration: WebsiteConfiguration | undefined;
|
|
796
|
+
/**
|
|
797
|
+
* <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
|
|
798
|
+
* @public
|
|
799
|
+
*/
|
|
800
|
+
ExpectedBucketOwner?: string | undefined;
|
|
801
|
+
}
|
|
802
|
+
/**
|
|
803
|
+
* <p>
|
|
804
|
+
* The existing object was created with a different encryption type.
|
|
805
|
+
* Subsequent write requests must include the appropriate encryption
|
|
806
|
+
* parameters in the request or while creating the session.
|
|
807
|
+
* </p>
|
|
808
|
+
* @public
|
|
809
|
+
*/
|
|
810
|
+
export declare class EncryptionTypeMismatch extends __BaseException {
|
|
811
|
+
readonly name: "EncryptionTypeMismatch";
|
|
812
|
+
readonly $fault: "client";
|
|
813
|
+
/**
|
|
814
|
+
* @internal
|
|
815
|
+
*/
|
|
816
|
+
constructor(opts: __ExceptionOptionType<EncryptionTypeMismatch, __BaseException>);
|
|
817
|
+
}
|
|
818
|
+
/**
|
|
819
|
+
* <p>You may receive this error in multiple cases. Depending on the reason for the error, you may receive one of the messages below:</p>
|
|
820
|
+
* <ul>
|
|
821
|
+
* <li>
|
|
822
|
+
* <p>Cannot specify both a write offset value and user-defined object metadata for existing objects.</p>
|
|
823
|
+
* </li>
|
|
824
|
+
* <li>
|
|
825
|
+
* <p>Checksum Type mismatch occurred, expected checksum Type: sha1, actual checksum Type: crc32c.</p>
|
|
826
|
+
* </li>
|
|
827
|
+
* <li>
|
|
828
|
+
* <p>Request body cannot be empty when 'write offset' is specified.</p>
|
|
829
|
+
* </li>
|
|
830
|
+
* </ul>
|
|
831
|
+
* @public
|
|
832
|
+
*/
|
|
833
|
+
export declare class InvalidRequest extends __BaseException {
|
|
834
|
+
readonly name: "InvalidRequest";
|
|
835
|
+
readonly $fault: "client";
|
|
836
|
+
/**
|
|
837
|
+
* @internal
|
|
838
|
+
*/
|
|
839
|
+
constructor(opts: __ExceptionOptionType<InvalidRequest, __BaseException>);
|
|
840
|
+
}
|
|
841
|
+
/**
|
|
842
|
+
* <p>
|
|
843
|
+
* The write offset value that you specified does not match the current object size.
|
|
844
|
+
* </p>
|
|
845
|
+
* @public
|
|
846
|
+
*/
|
|
847
|
+
export declare class InvalidWriteOffset extends __BaseException {
|
|
848
|
+
readonly name: "InvalidWriteOffset";
|
|
849
|
+
readonly $fault: "client";
|
|
850
|
+
/**
|
|
851
|
+
* @internal
|
|
852
|
+
*/
|
|
853
|
+
constructor(opts: __ExceptionOptionType<InvalidWriteOffset, __BaseException>);
|
|
854
|
+
}
|
|
855
|
+
/**
|
|
856
|
+
* @public
|
|
857
|
+
*/
|
|
858
|
+
export interface PutObjectOutput {
|
|
859
|
+
/**
|
|
860
|
+
* <p>If the expiration is configured for the object (see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html">PutBucketLifecycleConfiguration</a>) in the <i>Amazon S3 User Guide</i>,
|
|
861
|
+
* the response includes this header. It includes the <code>expiry-date</code> and
|
|
862
|
+
* <code>rule-id</code> key-value pairs that provide information about object expiration.
|
|
863
|
+
* The value of the <code>rule-id</code> is URL-encoded.</p>
|
|
864
|
+
* <note>
|
|
865
|
+
* <p>Object expiration information is not returned in directory buckets and this header returns the value "<code>NotImplemented</code>" in all responses for directory buckets.</p>
|
|
866
|
+
* </note>
|
|
867
|
+
* @public
|
|
868
|
+
*/
|
|
869
|
+
Expiration?: string | undefined;
|
|
870
|
+
/**
|
|
871
|
+
* <p>Entity tag for the uploaded object.</p>
|
|
872
|
+
* <p>
|
|
873
|
+
* <b>General purpose buckets </b> - To ensure that data is not
|
|
874
|
+
* corrupted traversing the network, for objects where the ETag is the MD5 digest of the
|
|
875
|
+
* object, you can calculate the MD5 while putting an object to Amazon S3 and compare the returned
|
|
876
|
+
* ETag to the calculated MD5 value.</p>
|
|
877
|
+
* <p>
|
|
878
|
+
* <b>Directory buckets </b> - The ETag for the object in
|
|
879
|
+
* a directory bucket isn't the MD5 digest of the object.</p>
|
|
880
|
+
* @public
|
|
881
|
+
*/
|
|
882
|
+
ETag?: string | undefined;
|
|
883
|
+
/**
|
|
884
|
+
* <p>The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded
|
|
885
|
+
* with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated
|
|
886
|
+
* with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums">
|
|
887
|
+
* Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
888
|
+
* @public
|
|
889
|
+
*/
|
|
890
|
+
ChecksumCRC32?: string | undefined;
|
|
891
|
+
/**
|
|
892
|
+
* <p>The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded
|
|
893
|
+
* with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated
|
|
894
|
+
* with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums">
|
|
895
|
+
* Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
896
|
+
* @public
|
|
897
|
+
*/
|
|
898
|
+
ChecksumCRC32C?: string | undefined;
|
|
899
|
+
/**
|
|
900
|
+
* <p>The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded
|
|
901
|
+
* with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated
|
|
902
|
+
* with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums">
|
|
903
|
+
* Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
904
|
+
* @public
|
|
905
|
+
*/
|
|
906
|
+
ChecksumSHA1?: string | undefined;
|
|
907
|
+
/**
|
|
908
|
+
* <p>The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded
|
|
909
|
+
* with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated
|
|
910
|
+
* with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums">
|
|
911
|
+
* Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
912
|
+
* @public
|
|
913
|
+
*/
|
|
914
|
+
ChecksumSHA256?: string | undefined;
|
|
915
|
+
/**
|
|
916
|
+
* <p>The server-side encryption algorithm used when you store this object in Amazon S3.</p>
|
|
917
|
+
* @public
|
|
918
|
+
*/
|
|
919
|
+
ServerSideEncryption?: ServerSideEncryption | undefined;
|
|
920
|
+
/**
|
|
921
|
+
* <p>Version ID of the object.</p>
|
|
922
|
+
* <p>If you enable versioning for a bucket, Amazon S3 automatically generates a unique version ID
|
|
923
|
+
* for the object being stored. Amazon S3 returns this ID in the response. When you enable
|
|
924
|
+
* versioning for a bucket, if Amazon S3 receives multiple write requests for the same object
|
|
925
|
+
* simultaneously, it stores all of the objects. For more information about versioning, see
|
|
926
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/AddingObjectstoVersioningEnabledBuckets.html">Adding Objects to
|
|
927
|
+
* Versioning-Enabled Buckets</a> in the <i>Amazon S3 User Guide</i>. For
|
|
928
|
+
* information about returning the versioning state of a bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html">GetBucketVersioning</a>. </p>
|
|
929
|
+
* <note>
|
|
930
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
931
|
+
* </note>
|
|
932
|
+
* @public
|
|
933
|
+
*/
|
|
934
|
+
VersionId?: string | undefined;
|
|
935
|
+
/**
|
|
936
|
+
* <p>If server-side encryption with a customer-provided encryption key was requested, the
|
|
937
|
+
* response will include this header to confirm the encryption algorithm that's used.</p>
|
|
938
|
+
* <note>
|
|
939
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
940
|
+
* </note>
|
|
941
|
+
* @public
|
|
942
|
+
*/
|
|
943
|
+
SSECustomerAlgorithm?: string | undefined;
|
|
944
|
+
/**
|
|
945
|
+
* <p>If server-side encryption with a customer-provided encryption key was requested, the
|
|
946
|
+
* response will include this header to provide the round-trip message integrity verification
|
|
947
|
+
* of the customer-provided encryption key.</p>
|
|
948
|
+
* <note>
|
|
949
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
950
|
+
* </note>
|
|
951
|
+
* @public
|
|
952
|
+
*/
|
|
953
|
+
SSECustomerKeyMD5?: string | undefined;
|
|
954
|
+
/**
|
|
955
|
+
* <p>If present, indicates the ID of the KMS key that was used for object encryption.</p>
|
|
956
|
+
* @public
|
|
957
|
+
*/
|
|
958
|
+
SSEKMSKeyId?: string | undefined;
|
|
959
|
+
/**
|
|
960
|
+
* <p>If present, indicates the Amazon Web Services KMS Encryption Context to use for object encryption. The value of
|
|
961
|
+
* this header is a Base64-encoded string of a UTF-8 encoded JSON, which contains the encryption context as key-value pairs.
|
|
962
|
+
* This value is stored as object metadata and automatically gets
|
|
963
|
+
* passed on to Amazon Web Services KMS for future <code>GetObject</code>
|
|
964
|
+
* operations on this object.</p>
|
|
965
|
+
* @public
|
|
966
|
+
*/
|
|
967
|
+
SSEKMSEncryptionContext?: string | undefined;
|
|
968
|
+
/**
|
|
969
|
+
* <p>Indicates whether the uploaded object uses an S3 Bucket Key for server-side encryption
|
|
970
|
+
* with Key Management Service (KMS) keys (SSE-KMS).</p>
|
|
971
|
+
* @public
|
|
972
|
+
*/
|
|
973
|
+
BucketKeyEnabled?: boolean | undefined;
|
|
974
|
+
/**
|
|
975
|
+
* <p>
|
|
976
|
+
* The size of the object in bytes. This will only be present if you append to an object.
|
|
977
|
+
* </p>
|
|
978
|
+
* <note>
|
|
979
|
+
* <p>This functionality is only supported for objects in the Amazon S3 Express One Zone storage class in directory buckets.</p>
|
|
980
|
+
* </note>
|
|
981
|
+
* @public
|
|
982
|
+
*/
|
|
983
|
+
Size?: number | undefined;
|
|
984
|
+
/**
|
|
985
|
+
* <p>If present, indicates that the requester was successfully charged for the
|
|
986
|
+
* request.</p>
|
|
987
|
+
* <note>
|
|
988
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
989
|
+
* </note>
|
|
990
|
+
* @public
|
|
991
|
+
*/
|
|
992
|
+
RequestCharged?: RequestCharged | undefined;
|
|
993
|
+
}
|
|
994
|
+
/**
|
|
995
|
+
* @public
|
|
996
|
+
*/
|
|
997
|
+
export interface PutObjectRequest {
|
|
998
|
+
/**
|
|
999
|
+
* <p>The canned ACL to apply to the object. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL">Canned
|
|
1000
|
+
* ACL</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1001
|
+
* <p>When adding a new object, you can use headers to grant ACL-based permissions to
|
|
1002
|
+
* individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are
|
|
1003
|
+
* then added to the ACL on the object. By default, all objects are private. Only the owner
|
|
1004
|
+
* has full access control. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html">Access Control List (ACL) Overview</a>
|
|
1005
|
+
* and <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-using-rest-api.html">Managing
|
|
1006
|
+
* ACLs Using the REST API</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1007
|
+
* <p>If the bucket that you're uploading objects to uses the bucket owner enforced setting
|
|
1008
|
+
* for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that
|
|
1009
|
+
* use this setting only accept PUT requests that don't specify an ACL or PUT requests that
|
|
1010
|
+
* specify bucket owner full control ACLs, such as the <code>bucket-owner-full-control</code>
|
|
1011
|
+
* canned ACL or an equivalent form of this ACL expressed in the XML format. PUT requests that
|
|
1012
|
+
* contain other ACLs (for example, custom grants to certain Amazon Web Services accounts) fail and return a
|
|
1013
|
+
* <code>400</code> error with the error code <code>AccessControlListNotSupported</code>.
|
|
1014
|
+
* For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html"> Controlling ownership of
|
|
1015
|
+
* objects and disabling ACLs</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1016
|
+
* <note>
|
|
1017
|
+
* <ul>
|
|
1018
|
+
* <li>
|
|
1019
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
1020
|
+
* </li>
|
|
1021
|
+
* <li>
|
|
1022
|
+
* <p>This functionality is not supported for Amazon S3 on Outposts.</p>
|
|
1023
|
+
* </li>
|
|
1024
|
+
* </ul>
|
|
1025
|
+
* </note>
|
|
1026
|
+
* @public
|
|
1027
|
+
*/
|
|
1028
|
+
ACL?: ObjectCannedACL | undefined;
|
|
1029
|
+
/**
|
|
1030
|
+
* <p>Object data.</p>
|
|
1031
|
+
* @public
|
|
1032
|
+
*/
|
|
1033
|
+
Body?: StreamingBlobTypes | undefined;
|
|
1034
|
+
/**
|
|
1035
|
+
* <p>The bucket name to which the PUT action was initiated. </p>
|
|
1036
|
+
* <p>
|
|
1037
|
+
* <b>Directory buckets</b> -
|
|
1038
|
+
* When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code>
|
|
1039
|
+
* <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format <code>
|
|
1040
|
+
* <i>bucket-base-name</i>--<i>zone-id</i>--x-s3</code> (for example, <code>
|
|
1041
|
+
* <i>DOC-EXAMPLE-BUCKET</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming
|
|
1042
|
+
* restrictions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html">Directory bucket naming
|
|
1043
|
+
* rules</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1044
|
+
* <p>
|
|
1045
|
+
* <b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1046
|
+
* <note>
|
|
1047
|
+
* <p>Access points and Object Lambda access points are not supported by directory buckets.</p>
|
|
1048
|
+
* </note>
|
|
1049
|
+
* <p>
|
|
1050
|
+
* <b>S3 on Outposts</b> - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code>
|
|
1051
|
+
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1052
|
+
* <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
|
|
1053
|
+
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
1054
|
+
* @public
|
|
1055
|
+
*/
|
|
1056
|
+
Bucket: string | undefined;
|
|
1057
|
+
/**
|
|
1058
|
+
* <p>Can be used to specify caching behavior along the request/reply chain. For more
|
|
1059
|
+
* information, see <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9">http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9</a>.</p>
|
|
1060
|
+
* @public
|
|
1061
|
+
*/
|
|
1062
|
+
CacheControl?: string | undefined;
|
|
1063
|
+
/**
|
|
1064
|
+
* <p>Specifies presentational information for the object. For more information, see <a href="https://www.rfc-editor.org/rfc/rfc6266#section-4">https://www.rfc-editor.org/rfc/rfc6266#section-4</a>.</p>
|
|
1065
|
+
* @public
|
|
1066
|
+
*/
|
|
1067
|
+
ContentDisposition?: string | undefined;
|
|
1068
|
+
/**
|
|
1069
|
+
* <p>Specifies what content encodings have been applied to the object and thus what decoding
|
|
1070
|
+
* mechanisms must be applied to obtain the media-type referenced by the Content-Type header
|
|
1071
|
+
* field. For more information, see <a href="https://www.rfc-editor.org/rfc/rfc9110.html#field.content-encoding">https://www.rfc-editor.org/rfc/rfc9110.html#field.content-encoding</a>.</p>
|
|
1072
|
+
* @public
|
|
1073
|
+
*/
|
|
1074
|
+
ContentEncoding?: string | undefined;
|
|
1075
|
+
/**
|
|
1076
|
+
* <p>The language the content is in.</p>
|
|
1077
|
+
* @public
|
|
1078
|
+
*/
|
|
1079
|
+
ContentLanguage?: string | undefined;
|
|
1080
|
+
/**
|
|
1081
|
+
* <p>Size of the body in bytes. This parameter is useful when the size of the body cannot be
|
|
1082
|
+
* determined automatically. For more information, see <a href="https://www.rfc-editor.org/rfc/rfc9110.html#name-content-length">https://www.rfc-editor.org/rfc/rfc9110.html#name-content-length</a>.</p>
|
|
1083
|
+
* @public
|
|
1084
|
+
*/
|
|
1085
|
+
ContentLength?: number | undefined;
|
|
1086
|
+
/**
|
|
1087
|
+
* <p>The base64-encoded 128-bit MD5 digest of the message (without the headers) according to
|
|
1088
|
+
* RFC 1864. This header can be used as a message integrity check to verify that the data is
|
|
1089
|
+
* the same data that was originally sent. Although it is optional, we recommend using the
|
|
1090
|
+
* Content-MD5 mechanism as an end-to-end integrity check. For more information about REST
|
|
1091
|
+
* request authentication, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html">REST Authentication</a>.</p>
|
|
1092
|
+
* <note>
|
|
1093
|
+
* <p>The <code>Content-MD5</code> or <code>x-amz-sdk-checksum-algorithm</code> header is
|
|
1094
|
+
* required for any request to upload an object with a retention period configured using
|
|
1095
|
+
* Amazon S3 Object Lock. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-managing.html#object-lock-put-object">Uploading objects to an Object Lock enabled bucket </a> in the
|
|
1096
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
1097
|
+
* </note>
|
|
1098
|
+
* <note>
|
|
1099
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
1100
|
+
* </note>
|
|
1101
|
+
* @public
|
|
1102
|
+
*/
|
|
1103
|
+
ContentMD5?: string | undefined;
|
|
1104
|
+
/**
|
|
1105
|
+
* <p>A standard MIME type describing the format of the contents. For more information, see
|
|
1106
|
+
* <a href="https://www.rfc-editor.org/rfc/rfc9110.html#name-content-type">https://www.rfc-editor.org/rfc/rfc9110.html#name-content-type</a>.</p>
|
|
1107
|
+
* @public
|
|
1108
|
+
*/
|
|
1109
|
+
ContentType?: string | undefined;
|
|
1110
|
+
/**
|
|
1111
|
+
* <p>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any
|
|
1112
|
+
* additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum-<i>algorithm</i>
|
|
1113
|
+
* </code> or
|
|
1114
|
+
* <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>.</p>
|
|
1115
|
+
* <p>For the <code>x-amz-checksum-<i>algorithm</i>
|
|
1116
|
+
* </code> header, replace <code>
|
|
1117
|
+
* <i>algorithm</i>
|
|
1118
|
+
* </code> with the supported algorithm from the following list: </p>
|
|
1119
|
+
* <ul>
|
|
1120
|
+
* <li>
|
|
1121
|
+
* <p>
|
|
1122
|
+
* <code>CRC32</code>
|
|
1123
|
+
* </p>
|
|
1124
|
+
* </li>
|
|
1125
|
+
* <li>
|
|
1126
|
+
* <p>
|
|
1127
|
+
* <code>CRC32C</code>
|
|
1128
|
+
* </p>
|
|
1129
|
+
* </li>
|
|
1130
|
+
* <li>
|
|
1131
|
+
* <p>
|
|
1132
|
+
* <code>SHA1</code>
|
|
1133
|
+
* </p>
|
|
1134
|
+
* </li>
|
|
1135
|
+
* <li>
|
|
1136
|
+
* <p>
|
|
1137
|
+
* <code>SHA256</code>
|
|
1138
|
+
* </p>
|
|
1139
|
+
* </li>
|
|
1140
|
+
* </ul>
|
|
1141
|
+
* <p>For more
|
|
1142
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
|
|
1143
|
+
* the <i>Amazon S3 User Guide</i>.</p>
|
|
1144
|
+
* <p>If the individual checksum value you provide through <code>x-amz-checksum-<i>algorithm</i>
|
|
1145
|
+
* </code> doesn't match the checksum algorithm you set through <code>x-amz-sdk-checksum-algorithm</code>, Amazon S3 ignores any provided
|
|
1146
|
+
* <code>ChecksumAlgorithm</code> parameter and uses the checksum algorithm that matches the provided value in <code>x-amz-checksum-<i>algorithm</i>
|
|
1147
|
+
* </code>.</p>
|
|
1148
|
+
* <note>
|
|
1149
|
+
* <p>The <code>Content-MD5</code> or <code>x-amz-sdk-checksum-algorithm</code> header is
|
|
1150
|
+
* required for any request to upload an object with a retention period configured using
|
|
1151
|
+
* Amazon S3 Object Lock. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-managing.html#object-lock-put-object">Uploading objects to an Object Lock enabled bucket </a> in the
|
|
1152
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
1153
|
+
* </note>
|
|
1154
|
+
* <p>For directory buckets, when you use Amazon Web Services SDKs, <code>CRC32</code> is the default checksum algorithm that's used for performance.</p>
|
|
1155
|
+
* @public
|
|
1156
|
+
*/
|
|
1157
|
+
ChecksumAlgorithm?: ChecksumAlgorithm | undefined;
|
|
1158
|
+
/**
|
|
1159
|
+
* <p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.
|
|
1160
|
+
* This header specifies the base64-encoded, 32-bit CRC-32 checksum of the object. For more information, see
|
|
1161
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in the
|
|
1162
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
1163
|
+
* @public
|
|
1164
|
+
*/
|
|
1165
|
+
ChecksumCRC32?: string | undefined;
|
|
1166
|
+
/**
|
|
1167
|
+
* <p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.
|
|
1168
|
+
* This header specifies the base64-encoded, 32-bit CRC-32C checksum of the object. For more information, see
|
|
1169
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in the
|
|
1170
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
1171
|
+
* @public
|
|
1172
|
+
*/
|
|
1173
|
+
ChecksumCRC32C?: string | undefined;
|
|
1174
|
+
/**
|
|
1175
|
+
* <p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.
|
|
1176
|
+
* This header specifies the base64-encoded, 160-bit SHA-1 digest of the object. For more information, see
|
|
1177
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in the
|
|
1178
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
1179
|
+
* @public
|
|
1180
|
+
*/
|
|
1181
|
+
ChecksumSHA1?: string | undefined;
|
|
1182
|
+
/**
|
|
1183
|
+
* <p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.
|
|
1184
|
+
* This header specifies the base64-encoded, 256-bit SHA-256 digest of the object. For more information, see
|
|
1185
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in the
|
|
1186
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
1187
|
+
* @public
|
|
1188
|
+
*/
|
|
1189
|
+
ChecksumSHA256?: string | undefined;
|
|
1190
|
+
/**
|
|
1191
|
+
* <p>The date and time at which the object is no longer cacheable. For more information, see
|
|
1192
|
+
* <a href="https://www.rfc-editor.org/rfc/rfc7234#section-5.3">https://www.rfc-editor.org/rfc/rfc7234#section-5.3</a>.</p>
|
|
1193
|
+
* @public
|
|
1194
|
+
*/
|
|
1195
|
+
Expires?: Date | undefined;
|
|
1196
|
+
/**
|
|
1197
|
+
* <p>Uploads the object only if the ETag (entity tag) value provided during the WRITE
|
|
1198
|
+
* operation matches the ETag of the object in S3. If the ETag values do not match, the
|
|
1199
|
+
* operation returns a <code>412 Precondition Failed</code> error.</p>
|
|
1200
|
+
* <p>If a conflicting operation occurs during the upload S3 returns a <code>409 ConditionalRequestConflict</code> response. On a 409 failure you should fetch the object's ETag and retry the upload.</p>
|
|
1201
|
+
* <p>Expects the ETag value as a string.</p>
|
|
1202
|
+
* <p>For more information about conditional requests, see <a href="https://tools.ietf.org/html/rfc7232">RFC 7232</a>, or <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/conditional-requests.html">Conditional requests</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1203
|
+
* @public
|
|
1204
|
+
*/
|
|
1205
|
+
IfMatch?: string | undefined;
|
|
1206
|
+
/**
|
|
1207
|
+
* <p>Uploads the object only if the object key name does not already exist in the bucket
|
|
1208
|
+
* specified. Otherwise, Amazon S3 returns a <code>412 Precondition Failed</code> error.</p>
|
|
1209
|
+
* <p>If a conflicting operation occurs during the upload S3 returns a <code>409
|
|
1210
|
+
* ConditionalRequestConflict</code> response. On a 409 failure you should retry the
|
|
1211
|
+
* upload.</p>
|
|
1212
|
+
* <p>Expects the '*' (asterisk) character.</p>
|
|
1213
|
+
* <p>For more information about conditional requests, see <a href="https://tools.ietf.org/html/rfc7232">RFC 7232</a>, or <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/conditional-requests.html">Conditional requests</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1214
|
+
* @public
|
|
1215
|
+
*/
|
|
1216
|
+
IfNoneMatch?: string | undefined;
|
|
1217
|
+
/**
|
|
1218
|
+
* <p>Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.</p>
|
|
1219
|
+
* <note>
|
|
1220
|
+
* <ul>
|
|
1221
|
+
* <li>
|
|
1222
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
1223
|
+
* </li>
|
|
1224
|
+
* <li>
|
|
1225
|
+
* <p>This functionality is not supported for Amazon S3 on Outposts.</p>
|
|
1226
|
+
* </li>
|
|
1227
|
+
* </ul>
|
|
1228
|
+
* </note>
|
|
1229
|
+
* @public
|
|
1230
|
+
*/
|
|
1231
|
+
GrantFullControl?: string | undefined;
|
|
1232
|
+
/**
|
|
1233
|
+
* <p>Allows grantee to read the object data and its metadata.</p>
|
|
1234
|
+
* <note>
|
|
1235
|
+
* <ul>
|
|
1236
|
+
* <li>
|
|
1237
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
1238
|
+
* </li>
|
|
1239
|
+
* <li>
|
|
1240
|
+
* <p>This functionality is not supported for Amazon S3 on Outposts.</p>
|
|
1241
|
+
* </li>
|
|
1242
|
+
* </ul>
|
|
1243
|
+
* </note>
|
|
1244
|
+
* @public
|
|
1245
|
+
*/
|
|
1246
|
+
GrantRead?: string | undefined;
|
|
1247
|
+
/**
|
|
1248
|
+
* <p>Allows grantee to read the object ACL.</p>
|
|
1249
|
+
* <note>
|
|
1250
|
+
* <ul>
|
|
1251
|
+
* <li>
|
|
1252
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
1253
|
+
* </li>
|
|
1254
|
+
* <li>
|
|
1255
|
+
* <p>This functionality is not supported for Amazon S3 on Outposts.</p>
|
|
1256
|
+
* </li>
|
|
1257
|
+
* </ul>
|
|
1258
|
+
* </note>
|
|
1259
|
+
* @public
|
|
1260
|
+
*/
|
|
1261
|
+
GrantReadACP?: string | undefined;
|
|
1262
|
+
/**
|
|
1263
|
+
* <p>Allows grantee to write the ACL for the applicable object.</p>
|
|
1264
|
+
* <note>
|
|
1265
|
+
* <ul>
|
|
1266
|
+
* <li>
|
|
1267
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
1268
|
+
* </li>
|
|
1269
|
+
* <li>
|
|
1270
|
+
* <p>This functionality is not supported for Amazon S3 on Outposts.</p>
|
|
1271
|
+
* </li>
|
|
1272
|
+
* </ul>
|
|
1273
|
+
* </note>
|
|
1274
|
+
* @public
|
|
1275
|
+
*/
|
|
1276
|
+
GrantWriteACP?: string | undefined;
|
|
1277
|
+
/**
|
|
1278
|
+
* <p>Object key for which the PUT action was initiated.</p>
|
|
1279
|
+
* @public
|
|
1280
|
+
*/
|
|
1281
|
+
Key: string | undefined;
|
|
1282
|
+
/**
|
|
1283
|
+
* <p>
|
|
1284
|
+
* Specifies the offset for appending data to existing objects in bytes.
|
|
1285
|
+
* The offset must be equal to the size of the existing object being appended to.
|
|
1286
|
+
* If no object exists, setting this header to 0 will create a new object.
|
|
1287
|
+
* </p>
|
|
1288
|
+
* <note>
|
|
1289
|
+
* <p>This functionality is only supported for objects in the Amazon S3 Express One Zone storage class in directory buckets.</p>
|
|
1290
|
+
* </note>
|
|
1291
|
+
* @public
|
|
1292
|
+
*/
|
|
1293
|
+
WriteOffsetBytes?: number | undefined;
|
|
1294
|
+
/**
|
|
1295
|
+
* <p>A map of metadata to store with the object in S3.</p>
|
|
1296
|
+
* @public
|
|
1297
|
+
*/
|
|
1298
|
+
Metadata?: Record<string, string> | undefined;
|
|
1299
|
+
/**
|
|
1300
|
+
* <p>The server-side encryption algorithm that was used when you store this object in Amazon S3
|
|
1301
|
+
* (for example, <code>AES256</code>, <code>aws:kms</code>, <code>aws:kms:dsse</code>).</p>
|
|
1302
|
+
* <ul>
|
|
1303
|
+
* <li>
|
|
1304
|
+
* <p>
|
|
1305
|
+
* <b>General purpose buckets </b> - You have four mutually
|
|
1306
|
+
* exclusive options to protect data using server-side encryption in Amazon S3, depending on
|
|
1307
|
+
* how you choose to manage the encryption keys. Specifically, the encryption key
|
|
1308
|
+
* options are Amazon S3 managed keys (SSE-S3), Amazon Web Services KMS keys (SSE-KMS or DSSE-KMS), and
|
|
1309
|
+
* customer-provided keys (SSE-C). Amazon S3 encrypts data with server-side encryption by
|
|
1310
|
+
* using Amazon S3 managed keys (SSE-S3) by default. You can optionally tell Amazon S3 to encrypt
|
|
1311
|
+
* data at rest by using server-side encryption with other key options. For more
|
|
1312
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html">Using Server-Side
|
|
1313
|
+
* Encryption</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1314
|
+
* </li>
|
|
1315
|
+
* <li>
|
|
1316
|
+
* <p>
|
|
1317
|
+
* <b>Directory buckets </b> -
|
|
1318
|
+
* For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (<code>AES256</code>) and server-side encryption with KMS keys (SSE-KMS) (<code>aws:kms</code>). We recommend that the bucket's default encryption uses the desired encryption configuration and you don't override the bucket default encryption in your
|
|
1319
|
+
* <code>CreateSession</code> requests or <code>PUT</code> object requests. Then, new objects
|
|
1320
|
+
* are automatically encrypted with the desired encryption settings. For more
|
|
1321
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-serv-side-encryption.html">Protecting data with server-side encryption</a> in the <i>Amazon S3 User Guide</i>. For more information about the encryption overriding behaviors in directory buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-specifying-kms-encryption.html">Specifying server-side encryption with KMS for new object uploads</a>. </p>
|
|
1322
|
+
* <p>In the Zonal endpoint API calls (except <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html">CopyObject</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html">UploadPartCopy</a>) using the REST API, the encryption request headers must match the encryption settings that are specified in the <code>CreateSession</code> request.
|
|
1323
|
+
* You can't override the values of the encryption settings (<code>x-amz-server-side-encryption</code>, <code>x-amz-server-side-encryption-aws-kms-key-id</code>, <code>x-amz-server-side-encryption-context</code>, and <code>x-amz-server-side-encryption-bucket-key-enabled</code>) that are specified in the <code>CreateSession</code> request.
|
|
1324
|
+
* You don't need to explicitly specify these encryption settings values in Zonal endpoint API calls, and
|
|
1325
|
+
* Amazon S3 will use the encryption settings values from the <code>CreateSession</code> request to protect new objects in the directory bucket.
|
|
1326
|
+
* </p>
|
|
1327
|
+
* <note>
|
|
1328
|
+
* <p>When you use the CLI or the Amazon Web Services SDKs, for <code>CreateSession</code>, the session token refreshes automatically to avoid service interruptions when a session expires. The CLI or the Amazon Web Services SDKs use the bucket's default encryption configuration for the
|
|
1329
|
+
* <code>CreateSession</code> request. It's not supported to override the encryption settings values in the <code>CreateSession</code> request.
|
|
1330
|
+
* So in the Zonal endpoint API calls (except <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html">CopyObject</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html">UploadPartCopy</a>),
|
|
1331
|
+
* the encryption request headers must match the default encryption configuration of the directory bucket.
|
|
1332
|
+
*
|
|
1333
|
+
* </p>
|
|
1334
|
+
* </note>
|
|
1335
|
+
* </li>
|
|
1336
|
+
* </ul>
|
|
1337
|
+
* @public
|
|
1338
|
+
*/
|
|
1339
|
+
ServerSideEncryption?: ServerSideEncryption | undefined;
|
|
1340
|
+
/**
|
|
1341
|
+
* <p>By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The
|
|
1342
|
+
* STANDARD storage class provides high durability and high availability. Depending on
|
|
1343
|
+
* performance needs, you can specify a different Storage Class. For more information, see
|
|
1344
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html">Storage
|
|
1345
|
+
* Classes</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1346
|
+
* <note>
|
|
1347
|
+
* <ul>
|
|
1348
|
+
* <li>
|
|
1349
|
+
* <p>For directory buckets, only the S3 Express One Zone storage class is supported to store
|
|
1350
|
+
* newly created objects.</p>
|
|
1351
|
+
* </li>
|
|
1352
|
+
* <li>
|
|
1353
|
+
* <p>Amazon S3 on Outposts only uses the OUTPOSTS Storage Class.</p>
|
|
1354
|
+
* </li>
|
|
1355
|
+
* </ul>
|
|
1356
|
+
* </note>
|
|
1357
|
+
* @public
|
|
1358
|
+
*/
|
|
1359
|
+
StorageClass?: StorageClass | undefined;
|
|
1360
|
+
/**
|
|
1361
|
+
* <p>If the bucket is configured as a website, redirects requests for this object to another
|
|
1362
|
+
* object in the same bucket or to an external URL. Amazon S3 stores the value of this header in
|
|
1363
|
+
* the object metadata. For information about object metadata, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html">Object Key and Metadata</a> in the
|
|
1364
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
1365
|
+
* <p>In the following example, the request header sets the redirect to an object
|
|
1366
|
+
* (anotherPage.html) in the same bucket:</p>
|
|
1367
|
+
* <p>
|
|
1368
|
+
* <code>x-amz-website-redirect-location: /anotherPage.html</code>
|
|
1369
|
+
* </p>
|
|
1370
|
+
* <p>In the following example, the request header sets the object redirect to another
|
|
1371
|
+
* website:</p>
|
|
1372
|
+
* <p>
|
|
1373
|
+
* <code>x-amz-website-redirect-location: http://www.example.com/</code>
|
|
1374
|
+
* </p>
|
|
1375
|
+
* <p>For more information about website hosting in Amazon S3, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html">Hosting Websites on Amazon S3</a> and
|
|
1376
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html">How to
|
|
1377
|
+
* Configure Website Page Redirects</a> in the <i>Amazon S3 User Guide</i>. </p>
|
|
1378
|
+
* <note>
|
|
1379
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
1380
|
+
* </note>
|
|
1381
|
+
* @public
|
|
1382
|
+
*/
|
|
1383
|
+
WebsiteRedirectLocation?: string | undefined;
|
|
1384
|
+
/**
|
|
1385
|
+
* <p>Specifies the algorithm to use when encrypting the object (for example,
|
|
1386
|
+
* <code>AES256</code>).</p>
|
|
1387
|
+
* <note>
|
|
1388
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
1389
|
+
* </note>
|
|
1390
|
+
* @public
|
|
1391
|
+
*/
|
|
1392
|
+
SSECustomerAlgorithm?: string | undefined;
|
|
1393
|
+
/**
|
|
1394
|
+
* <p>Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This
|
|
1395
|
+
* value is used to store the object and then it is discarded; Amazon S3 does not store the
|
|
1396
|
+
* encryption key. The key must be appropriate for use with the algorithm specified in the
|
|
1397
|
+
* <code>x-amz-server-side-encryption-customer-algorithm</code> header.</p>
|
|
1398
|
+
* <note>
|
|
1399
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
1400
|
+
* </note>
|
|
1401
|
+
* @public
|
|
1402
|
+
*/
|
|
1403
|
+
SSECustomerKey?: string | undefined;
|
|
1404
|
+
/**
|
|
1405
|
+
* <p>Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses
|
|
1406
|
+
* this header for a message integrity check to ensure that the encryption key was transmitted
|
|
1407
|
+
* without error.</p>
|
|
1408
|
+
* <note>
|
|
1409
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
1410
|
+
* </note>
|
|
1411
|
+
* @public
|
|
1412
|
+
*/
|
|
1413
|
+
SSECustomerKeyMD5?: string | undefined;
|
|
1414
|
+
/**
|
|
1415
|
+
* <p>Specifies the KMS key ID (Key ID, Key ARN, or Key Alias) to use for object encryption. If the KMS key doesn't exist in the same
|
|
1416
|
+
* account that's issuing the command, you must use the full Key ARN not the Key ID.</p>
|
|
1417
|
+
* <p>
|
|
1418
|
+
* <b>General purpose buckets</b> - If you specify <code>x-amz-server-side-encryption</code> with <code>aws:kms</code> or <code>aws:kms:dsse</code>, this header specifies the ID (Key ID, Key ARN, or Key Alias) of the KMS
|
|
1419
|
+
* key to use. If you specify
|
|
1420
|
+
* <code>x-amz-server-side-encryption:aws:kms</code> or
|
|
1421
|
+
* <code>x-amz-server-side-encryption:aws:kms:dsse</code>, but do not provide <code>x-amz-server-side-encryption-aws-kms-key-id</code>, Amazon S3 uses the Amazon Web Services managed key
|
|
1422
|
+
* (<code>aws/s3</code>) to protect the data.</p>
|
|
1423
|
+
* <p>
|
|
1424
|
+
* <b>Directory buckets</b> - If you specify <code>x-amz-server-side-encryption</code> with <code>aws:kms</code>, the <code>
|
|
1425
|
+
* x-amz-server-side-encryption-aws-kms-key-id</code> header is implicitly assigned the ID of the KMS
|
|
1426
|
+
* symmetric encryption customer managed key that's configured for your directory bucket's default encryption setting.
|
|
1427
|
+
* If you want to specify the <code>
|
|
1428
|
+
* x-amz-server-side-encryption-aws-kms-key-id</code> header explicitly, you can only specify it with the ID (Key ID or Key ARN) of the KMS
|
|
1429
|
+
* customer managed key that's configured for your directory bucket's default encryption setting. Otherwise, you get an HTTP <code>400 Bad Request</code> error. Only use the key ID or key ARN. The key alias format of the KMS key isn't supported. Your SSE-KMS configuration can only support 1 <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed key</a> per directory bucket for the lifetime of the bucket.
|
|
1430
|
+
* The <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk">Amazon Web Services managed key</a> (<code>aws/s3</code>) isn't supported.
|
|
1431
|
+
* </p>
|
|
1432
|
+
* @public
|
|
1433
|
+
*/
|
|
1434
|
+
SSEKMSKeyId?: string | undefined;
|
|
1435
|
+
/**
|
|
1436
|
+
* <p>Specifies the Amazon Web Services KMS Encryption Context as an additional encryption context to use for object encryption. The value of
|
|
1437
|
+
* this header is a Base64-encoded string of a UTF-8 encoded JSON, which contains the encryption context as key-value pairs.
|
|
1438
|
+
* This value is stored as object metadata and automatically gets passed on
|
|
1439
|
+
* to Amazon Web Services KMS for future <code>GetObject</code> operations on
|
|
1440
|
+
* this object.</p>
|
|
1441
|
+
* <p>
|
|
1442
|
+
* <b>General purpose buckets</b> - This value must be explicitly added during <code>CopyObject</code> operations if you want an additional encryption context for your object. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html#encryption-context">Encryption context</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1443
|
+
* <p>
|
|
1444
|
+
* <b>Directory buckets</b> - You can optionally provide an explicit encryption context value. The value must match the default encryption context - the bucket Amazon Resource Name (ARN). An additional encryption context value is not supported. </p>
|
|
1445
|
+
* @public
|
|
1446
|
+
*/
|
|
1447
|
+
SSEKMSEncryptionContext?: string | undefined;
|
|
1448
|
+
/**
|
|
1449
|
+
* <p>Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with
|
|
1450
|
+
* server-side encryption using Key Management Service (KMS) keys (SSE-KMS).</p>
|
|
1451
|
+
* <p>
|
|
1452
|
+
* <b>General purpose buckets</b> - Setting this header to
|
|
1453
|
+
* <code>true</code> causes Amazon S3 to use an S3 Bucket Key for object encryption with
|
|
1454
|
+
* SSE-KMS. Also, specifying this header with a PUT action doesn't affect bucket-level settings for S3
|
|
1455
|
+
* Bucket Key.</p>
|
|
1456
|
+
* <p>
|
|
1457
|
+
* <b>Directory buckets</b> - S3 Bucket Keys are always enabled for <code>GET</code> and <code>PUT</code> operations in a directory bucket and can’t be disabled. S3 Bucket Keys aren't supported, when you copy SSE-KMS encrypted objects from general purpose buckets
|
|
1458
|
+
* to directory buckets, from directory buckets to general purpose buckets, or between directory buckets, through <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html">CopyObject</a>, <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html">UploadPartCopy</a>, <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-objects-Batch-Ops">the Copy operation in Batch Operations</a>, or
|
|
1459
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/create-import-job">the import jobs</a>. In this case, Amazon S3 makes a call to KMS every time a copy request is made for a KMS-encrypted object.</p>
|
|
1460
|
+
* @public
|
|
1461
|
+
*/
|
|
1462
|
+
BucketKeyEnabled?: boolean | undefined;
|
|
1463
|
+
/**
|
|
1464
|
+
* <p>Confirms that the requester knows that they will be charged for the request. Bucket
|
|
1465
|
+
* owners need not specify this parameter in their requests. If either the source or
|
|
1466
|
+
* destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding
|
|
1467
|
+
* charges to copy the object. For information about downloading objects from Requester Pays
|
|
1468
|
+
* buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in
|
|
1469
|
+
* Requester Pays Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1470
|
+
* <note>
|
|
1471
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
1472
|
+
* </note>
|
|
1473
|
+
* @public
|
|
1474
|
+
*/
|
|
1475
|
+
RequestPayer?: RequestPayer | undefined;
|
|
1476
|
+
/**
|
|
1477
|
+
* <p>The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For
|
|
1478
|
+
* example, "Key1=Value1")</p>
|
|
1479
|
+
* <note>
|
|
1480
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
1481
|
+
* </note>
|
|
1482
|
+
* @public
|
|
1483
|
+
*/
|
|
1484
|
+
Tagging?: string | undefined;
|
|
1485
|
+
/**
|
|
1486
|
+
* <p>The Object Lock mode that you want to apply to this object.</p>
|
|
1487
|
+
* <note>
|
|
1488
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
1489
|
+
* </note>
|
|
1490
|
+
* @public
|
|
1491
|
+
*/
|
|
1492
|
+
ObjectLockMode?: ObjectLockMode | undefined;
|
|
1493
|
+
/**
|
|
1494
|
+
* <p>The date and time when you want this object's Object Lock to expire. Must be formatted
|
|
1495
|
+
* as a timestamp parameter.</p>
|
|
1496
|
+
* <note>
|
|
1497
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
1498
|
+
* </note>
|
|
1499
|
+
* @public
|
|
1500
|
+
*/
|
|
1501
|
+
ObjectLockRetainUntilDate?: Date | undefined;
|
|
1502
|
+
/**
|
|
1503
|
+
* <p>Specifies whether a legal hold will be applied to this object. For more information
|
|
1504
|
+
* about S3 Object Lock, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Object Lock</a> in the
|
|
1505
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
1506
|
+
* <note>
|
|
1507
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
1508
|
+
* </note>
|
|
1509
|
+
* @public
|
|
1510
|
+
*/
|
|
1511
|
+
ObjectLockLegalHoldStatus?: ObjectLockLegalHoldStatus | undefined;
|
|
1512
|
+
/**
|
|
1513
|
+
* <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
|
|
1514
|
+
* @public
|
|
1515
|
+
*/
|
|
1516
|
+
ExpectedBucketOwner?: string | undefined;
|
|
1517
|
+
}
|
|
1518
|
+
/**
|
|
1519
|
+
* <p>
|
|
1520
|
+
* You have attempted to add more parts than the maximum of 10000
|
|
1521
|
+
* that are allowed for this object. You can use the CopyObject operation
|
|
1522
|
+
* to copy this object to another and then add more data to the newly copied object.
|
|
1523
|
+
* </p>
|
|
1524
|
+
* @public
|
|
1525
|
+
*/
|
|
1526
|
+
export declare class TooManyParts extends __BaseException {
|
|
1527
|
+
readonly name: "TooManyParts";
|
|
1528
|
+
readonly $fault: "client";
|
|
1529
|
+
/**
|
|
1530
|
+
* @internal
|
|
1531
|
+
*/
|
|
1532
|
+
constructor(opts: __ExceptionOptionType<TooManyParts, __BaseException>);
|
|
1533
|
+
}
|
|
1534
|
+
/**
|
|
1535
|
+
* @public
|
|
1536
|
+
*/
|
|
1537
|
+
export interface PutObjectAclOutput {
|
|
1538
|
+
/**
|
|
1539
|
+
* <p>If present, indicates that the requester was successfully charged for the
|
|
1540
|
+
* request.</p>
|
|
1541
|
+
* <note>
|
|
1542
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
1543
|
+
* </note>
|
|
1544
|
+
* @public
|
|
1545
|
+
*/
|
|
1546
|
+
RequestCharged?: RequestCharged | undefined;
|
|
1547
|
+
}
|
|
1548
|
+
/**
|
|
1549
|
+
* @public
|
|
1550
|
+
*/
|
|
1551
|
+
export interface PutObjectAclRequest {
|
|
1552
|
+
/**
|
|
1553
|
+
* <p>The canned ACL to apply to the object. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL">Canned
|
|
1554
|
+
* ACL</a>.</p>
|
|
1555
|
+
* @public
|
|
1556
|
+
*/
|
|
1557
|
+
ACL?: ObjectCannedACL | undefined;
|
|
1558
|
+
/**
|
|
1559
|
+
* <p>Contains the elements that set the ACL permissions for an object per grantee.</p>
|
|
1560
|
+
* @public
|
|
1561
|
+
*/
|
|
1562
|
+
AccessControlPolicy?: AccessControlPolicy | undefined;
|
|
1563
|
+
/**
|
|
1564
|
+
* <p>The bucket name that contains the object to which you want to attach the ACL. </p>
|
|
1565
|
+
* <p>
|
|
1566
|
+
* <b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1567
|
+
* <p>
|
|
1568
|
+
* <b>S3 on Outposts</b> - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code>
|
|
1569
|
+
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1570
|
+
* <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
|
|
1571
|
+
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
1572
|
+
* @public
|
|
1573
|
+
*/
|
|
1574
|
+
Bucket: string | undefined;
|
|
1575
|
+
/**
|
|
1576
|
+
* <p>The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message
|
|
1577
|
+
* integrity check to verify that the request body was not corrupted in transit. For more
|
|
1578
|
+
* information, go to <a href="http://www.ietf.org/rfc/rfc1864.txt">RFC
|
|
1579
|
+
* 1864.></a>
|
|
1580
|
+
* </p>
|
|
1581
|
+
* <p>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</p>
|
|
1582
|
+
* @public
|
|
1583
|
+
*/
|
|
1584
|
+
ContentMD5?: string | undefined;
|
|
1585
|
+
/**
|
|
1586
|
+
* <p>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any
|
|
1587
|
+
* additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or
|
|
1588
|
+
* <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more
|
|
1589
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
|
|
1590
|
+
* the <i>Amazon S3 User Guide</i>.</p>
|
|
1591
|
+
* <p>If you provide an individual checksum, Amazon S3 ignores any provided
|
|
1592
|
+
* <code>ChecksumAlgorithm</code> parameter.</p>
|
|
1593
|
+
* @public
|
|
1594
|
+
*/
|
|
1595
|
+
ChecksumAlgorithm?: ChecksumAlgorithm | undefined;
|
|
1596
|
+
/**
|
|
1597
|
+
* <p>Allows grantee the read, write, read ACP, and write ACP permissions on the
|
|
1598
|
+
* bucket.</p>
|
|
1599
|
+
* <p>This functionality is not supported for Amazon S3 on Outposts.</p>
|
|
1600
|
+
* @public
|
|
1601
|
+
*/
|
|
1602
|
+
GrantFullControl?: string | undefined;
|
|
1603
|
+
/**
|
|
1604
|
+
* <p>Allows grantee to list the objects in the bucket.</p>
|
|
1605
|
+
* <p>This functionality is not supported for Amazon S3 on Outposts.</p>
|
|
1606
|
+
* @public
|
|
1607
|
+
*/
|
|
1608
|
+
GrantRead?: string | undefined;
|
|
1609
|
+
/**
|
|
1610
|
+
* <p>Allows grantee to read the bucket ACL.</p>
|
|
1611
|
+
* <p>This functionality is not supported for Amazon S3 on Outposts.</p>
|
|
1612
|
+
* @public
|
|
1613
|
+
*/
|
|
1614
|
+
GrantReadACP?: string | undefined;
|
|
1615
|
+
/**
|
|
1616
|
+
* <p>Allows grantee to create new objects in the bucket.</p>
|
|
1617
|
+
* <p>For the bucket and object owners of existing objects, also allows deletions and
|
|
1618
|
+
* overwrites of those objects.</p>
|
|
1619
|
+
* @public
|
|
1620
|
+
*/
|
|
1621
|
+
GrantWrite?: string | undefined;
|
|
1622
|
+
/**
|
|
1623
|
+
* <p>Allows grantee to write the ACL for the applicable bucket.</p>
|
|
1624
|
+
* <p>This functionality is not supported for Amazon S3 on Outposts.</p>
|
|
1625
|
+
* @public
|
|
1626
|
+
*/
|
|
1627
|
+
GrantWriteACP?: string | undefined;
|
|
1628
|
+
/**
|
|
1629
|
+
* <p>Key for which the PUT action was initiated.</p>
|
|
1630
|
+
* @public
|
|
1631
|
+
*/
|
|
1632
|
+
Key: string | undefined;
|
|
1633
|
+
/**
|
|
1634
|
+
* <p>Confirms that the requester knows that they will be charged for the request. Bucket
|
|
1635
|
+
* owners need not specify this parameter in their requests. If either the source or
|
|
1636
|
+
* destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding
|
|
1637
|
+
* charges to copy the object. For information about downloading objects from Requester Pays
|
|
1638
|
+
* buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in
|
|
1639
|
+
* Requester Pays Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1640
|
+
* <note>
|
|
1641
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
1642
|
+
* </note>
|
|
1643
|
+
* @public
|
|
1644
|
+
*/
|
|
1645
|
+
RequestPayer?: RequestPayer | undefined;
|
|
1646
|
+
/**
|
|
1647
|
+
* <p>Version ID used to reference a specific version of the object.</p>
|
|
1648
|
+
* <note>
|
|
1649
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
1650
|
+
* </note>
|
|
1651
|
+
* @public
|
|
1652
|
+
*/
|
|
1653
|
+
VersionId?: string | undefined;
|
|
1654
|
+
/**
|
|
1655
|
+
* <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
|
|
1656
|
+
* @public
|
|
1657
|
+
*/
|
|
1658
|
+
ExpectedBucketOwner?: string | undefined;
|
|
1659
|
+
}
|
|
1660
|
+
/**
|
|
1661
|
+
* @public
|
|
1662
|
+
*/
|
|
1663
|
+
export interface PutObjectLegalHoldOutput {
|
|
1664
|
+
/**
|
|
1665
|
+
* <p>If present, indicates that the requester was successfully charged for the
|
|
1666
|
+
* request.</p>
|
|
1667
|
+
* <note>
|
|
1668
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
1669
|
+
* </note>
|
|
1670
|
+
* @public
|
|
1671
|
+
*/
|
|
1672
|
+
RequestCharged?: RequestCharged | undefined;
|
|
1673
|
+
}
|
|
1674
|
+
/**
|
|
1675
|
+
* @public
|
|
1676
|
+
*/
|
|
1677
|
+
export interface PutObjectLegalHoldRequest {
|
|
1678
|
+
/**
|
|
1679
|
+
* <p>The bucket name containing the object that you want to place a legal hold on. </p>
|
|
1680
|
+
* <p>
|
|
1681
|
+
* <b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1682
|
+
* <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
|
|
1683
|
+
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
1684
|
+
* @public
|
|
1685
|
+
*/
|
|
1686
|
+
Bucket: string | undefined;
|
|
1687
|
+
/**
|
|
1688
|
+
* <p>The key name for the object that you want to place a legal hold on.</p>
|
|
1689
|
+
* @public
|
|
1690
|
+
*/
|
|
1691
|
+
Key: string | undefined;
|
|
1692
|
+
/**
|
|
1693
|
+
* <p>Container element for the legal hold configuration you want to apply to the specified
|
|
1694
|
+
* object.</p>
|
|
1695
|
+
* @public
|
|
1696
|
+
*/
|
|
1697
|
+
LegalHold?: ObjectLockLegalHold | undefined;
|
|
1698
|
+
/**
|
|
1699
|
+
* <p>Confirms that the requester knows that they will be charged for the request. Bucket
|
|
1700
|
+
* owners need not specify this parameter in their requests. If either the source or
|
|
1701
|
+
* destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding
|
|
1702
|
+
* charges to copy the object. For information about downloading objects from Requester Pays
|
|
1703
|
+
* buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in
|
|
1704
|
+
* Requester Pays Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1705
|
+
* <note>
|
|
1706
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
1707
|
+
* </note>
|
|
1708
|
+
* @public
|
|
1709
|
+
*/
|
|
1710
|
+
RequestPayer?: RequestPayer | undefined;
|
|
1711
|
+
/**
|
|
1712
|
+
* <p>The version ID of the object that you want to place a legal hold on.</p>
|
|
1713
|
+
* @public
|
|
1714
|
+
*/
|
|
1715
|
+
VersionId?: string | undefined;
|
|
1716
|
+
/**
|
|
1717
|
+
* <p>The MD5 hash for the request body.</p>
|
|
1718
|
+
* <p>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</p>
|
|
1719
|
+
* @public
|
|
1720
|
+
*/
|
|
1721
|
+
ContentMD5?: string | undefined;
|
|
1722
|
+
/**
|
|
1723
|
+
* <p>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any
|
|
1724
|
+
* additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or
|
|
1725
|
+
* <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more
|
|
1726
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
|
|
1727
|
+
* the <i>Amazon S3 User Guide</i>.</p>
|
|
1728
|
+
* <p>If you provide an individual checksum, Amazon S3 ignores any provided
|
|
1729
|
+
* <code>ChecksumAlgorithm</code> parameter.</p>
|
|
1730
|
+
* @public
|
|
1731
|
+
*/
|
|
1732
|
+
ChecksumAlgorithm?: ChecksumAlgorithm | undefined;
|
|
1733
|
+
/**
|
|
1734
|
+
* <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
|
|
1735
|
+
* @public
|
|
1736
|
+
*/
|
|
1737
|
+
ExpectedBucketOwner?: string | undefined;
|
|
1738
|
+
}
|
|
1739
|
+
/**
|
|
1740
|
+
* @public
|
|
1741
|
+
*/
|
|
1742
|
+
export interface PutObjectLockConfigurationOutput {
|
|
1743
|
+
/**
|
|
1744
|
+
* <p>If present, indicates that the requester was successfully charged for the
|
|
1745
|
+
* request.</p>
|
|
1746
|
+
* <note>
|
|
1747
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
1748
|
+
* </note>
|
|
1749
|
+
* @public
|
|
1750
|
+
*/
|
|
1751
|
+
RequestCharged?: RequestCharged | undefined;
|
|
1752
|
+
}
|
|
1753
|
+
/**
|
|
1754
|
+
* @public
|
|
1755
|
+
*/
|
|
1756
|
+
export interface PutObjectLockConfigurationRequest {
|
|
1757
|
+
/**
|
|
1758
|
+
* <p>The bucket whose Object Lock configuration you want to create or replace.</p>
|
|
1759
|
+
* <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
|
|
1760
|
+
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
1761
|
+
* @public
|
|
1762
|
+
*/
|
|
1763
|
+
Bucket: string | undefined;
|
|
1764
|
+
/**
|
|
1765
|
+
* <p>The Object Lock configuration that you want to apply to the specified bucket.</p>
|
|
1766
|
+
* @public
|
|
1767
|
+
*/
|
|
1768
|
+
ObjectLockConfiguration?: ObjectLockConfiguration | undefined;
|
|
1769
|
+
/**
|
|
1770
|
+
* <p>Confirms that the requester knows that they will be charged for the request. Bucket
|
|
1771
|
+
* owners need not specify this parameter in their requests. If either the source or
|
|
1772
|
+
* destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding
|
|
1773
|
+
* charges to copy the object. For information about downloading objects from Requester Pays
|
|
1774
|
+
* buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in
|
|
1775
|
+
* Requester Pays Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1776
|
+
* <note>
|
|
1777
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
1778
|
+
* </note>
|
|
1779
|
+
* @public
|
|
1780
|
+
*/
|
|
1781
|
+
RequestPayer?: RequestPayer | undefined;
|
|
1782
|
+
/**
|
|
1783
|
+
* <p>A token to allow Object Lock to be enabled for an existing bucket.</p>
|
|
1784
|
+
* @public
|
|
1785
|
+
*/
|
|
1786
|
+
Token?: string | undefined;
|
|
1787
|
+
/**
|
|
1788
|
+
* <p>The MD5 hash for the request body.</p>
|
|
1789
|
+
* <p>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</p>
|
|
1790
|
+
* @public
|
|
1791
|
+
*/
|
|
1792
|
+
ContentMD5?: string | undefined;
|
|
1793
|
+
/**
|
|
1794
|
+
* <p>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any
|
|
1795
|
+
* additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or
|
|
1796
|
+
* <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more
|
|
1797
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
|
|
1798
|
+
* the <i>Amazon S3 User Guide</i>.</p>
|
|
1799
|
+
* <p>If you provide an individual checksum, Amazon S3 ignores any provided
|
|
1800
|
+
* <code>ChecksumAlgorithm</code> parameter.</p>
|
|
1801
|
+
* @public
|
|
1802
|
+
*/
|
|
1803
|
+
ChecksumAlgorithm?: ChecksumAlgorithm | undefined;
|
|
1804
|
+
/**
|
|
1805
|
+
* <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
|
|
1806
|
+
* @public
|
|
1807
|
+
*/
|
|
1808
|
+
ExpectedBucketOwner?: string | undefined;
|
|
1809
|
+
}
|
|
1810
|
+
/**
|
|
1811
|
+
* @public
|
|
1812
|
+
*/
|
|
1813
|
+
export interface PutObjectRetentionOutput {
|
|
1814
|
+
/**
|
|
1815
|
+
* <p>If present, indicates that the requester was successfully charged for the
|
|
1816
|
+
* request.</p>
|
|
1817
|
+
* <note>
|
|
1818
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
1819
|
+
* </note>
|
|
1820
|
+
* @public
|
|
1821
|
+
*/
|
|
1822
|
+
RequestCharged?: RequestCharged | undefined;
|
|
1823
|
+
}
|
|
1824
|
+
/**
|
|
1825
|
+
* @public
|
|
1826
|
+
*/
|
|
1827
|
+
export interface PutObjectRetentionRequest {
|
|
1828
|
+
/**
|
|
1829
|
+
* <p>The bucket name that contains the object you want to apply this Object Retention
|
|
1830
|
+
* configuration to. </p>
|
|
1831
|
+
* <p>
|
|
1832
|
+
* <b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1833
|
+
* <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
|
|
1834
|
+
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
1835
|
+
* @public
|
|
1836
|
+
*/
|
|
1837
|
+
Bucket: string | undefined;
|
|
1838
|
+
/**
|
|
1839
|
+
* <p>The key name for the object that you want to apply this Object Retention configuration
|
|
1840
|
+
* to.</p>
|
|
1841
|
+
* @public
|
|
1842
|
+
*/
|
|
1843
|
+
Key: string | undefined;
|
|
1844
|
+
/**
|
|
1845
|
+
* <p>The container element for the Object Retention configuration.</p>
|
|
1846
|
+
* @public
|
|
1847
|
+
*/
|
|
1848
|
+
Retention?: ObjectLockRetention | undefined;
|
|
1849
|
+
/**
|
|
1850
|
+
* <p>Confirms that the requester knows that they will be charged for the request. Bucket
|
|
1851
|
+
* owners need not specify this parameter in their requests. If either the source or
|
|
1852
|
+
* destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding
|
|
1853
|
+
* charges to copy the object. For information about downloading objects from Requester Pays
|
|
1854
|
+
* buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in
|
|
1855
|
+
* Requester Pays Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1856
|
+
* <note>
|
|
1857
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
1858
|
+
* </note>
|
|
1859
|
+
* @public
|
|
1860
|
+
*/
|
|
1861
|
+
RequestPayer?: RequestPayer | undefined;
|
|
1862
|
+
/**
|
|
1863
|
+
* <p>The version ID for the object that you want to apply this Object Retention configuration
|
|
1864
|
+
* to.</p>
|
|
1865
|
+
* @public
|
|
1866
|
+
*/
|
|
1867
|
+
VersionId?: string | undefined;
|
|
1868
|
+
/**
|
|
1869
|
+
* <p>Indicates whether this action should bypass Governance-mode restrictions.</p>
|
|
1870
|
+
* @public
|
|
1871
|
+
*/
|
|
1872
|
+
BypassGovernanceRetention?: boolean | undefined;
|
|
1873
|
+
/**
|
|
1874
|
+
* <p>The MD5 hash for the request body.</p>
|
|
1875
|
+
* <p>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</p>
|
|
1876
|
+
* @public
|
|
1877
|
+
*/
|
|
1878
|
+
ContentMD5?: string | undefined;
|
|
1879
|
+
/**
|
|
1880
|
+
* <p>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any
|
|
1881
|
+
* additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or
|
|
1882
|
+
* <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more
|
|
1883
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
|
|
1884
|
+
* the <i>Amazon S3 User Guide</i>.</p>
|
|
1885
|
+
* <p>If you provide an individual checksum, Amazon S3 ignores any provided
|
|
1886
|
+
* <code>ChecksumAlgorithm</code> parameter.</p>
|
|
1887
|
+
* @public
|
|
1888
|
+
*/
|
|
1889
|
+
ChecksumAlgorithm?: ChecksumAlgorithm | undefined;
|
|
1890
|
+
/**
|
|
1891
|
+
* <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
|
|
1892
|
+
* @public
|
|
1893
|
+
*/
|
|
1894
|
+
ExpectedBucketOwner?: string | undefined;
|
|
1895
|
+
}
|
|
1896
|
+
/**
|
|
1897
|
+
* @public
|
|
1898
|
+
*/
|
|
1899
|
+
export interface PutObjectTaggingOutput {
|
|
1900
|
+
/**
|
|
1901
|
+
* <p>The versionId of the object the tag-set was added to.</p>
|
|
1902
|
+
* @public
|
|
1903
|
+
*/
|
|
1904
|
+
VersionId?: string | undefined;
|
|
1905
|
+
}
|
|
1906
|
+
/**
|
|
1907
|
+
* @public
|
|
1908
|
+
*/
|
|
1909
|
+
export interface PutObjectTaggingRequest {
|
|
1910
|
+
/**
|
|
1911
|
+
* <p>The bucket name containing the object. </p>
|
|
1912
|
+
* <p>
|
|
1913
|
+
* <b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1914
|
+
* <p>
|
|
1915
|
+
* <b>S3 on Outposts</b> - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code>
|
|
1916
|
+
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1917
|
+
* <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
|
|
1918
|
+
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
1919
|
+
* @public
|
|
1920
|
+
*/
|
|
1921
|
+
Bucket: string | undefined;
|
|
1922
|
+
/**
|
|
1923
|
+
* <p>Name of the object key.</p>
|
|
1924
|
+
* @public
|
|
1925
|
+
*/
|
|
1926
|
+
Key: string | undefined;
|
|
1927
|
+
/**
|
|
1928
|
+
* <p>The versionId of the object that the tag-set will be added to.</p>
|
|
1929
|
+
* @public
|
|
1930
|
+
*/
|
|
1931
|
+
VersionId?: string | undefined;
|
|
1932
|
+
/**
|
|
1933
|
+
* <p>The MD5 hash for the request body.</p>
|
|
1934
|
+
* <p>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</p>
|
|
1935
|
+
* @public
|
|
1936
|
+
*/
|
|
1937
|
+
ContentMD5?: string | undefined;
|
|
1938
|
+
/**
|
|
1939
|
+
* <p>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any
|
|
1940
|
+
* additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or
|
|
1941
|
+
* <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more
|
|
1942
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
|
|
1943
|
+
* the <i>Amazon S3 User Guide</i>.</p>
|
|
1944
|
+
* <p>If you provide an individual checksum, Amazon S3 ignores any provided
|
|
1945
|
+
* <code>ChecksumAlgorithm</code> parameter.</p>
|
|
1946
|
+
* @public
|
|
1947
|
+
*/
|
|
1948
|
+
ChecksumAlgorithm?: ChecksumAlgorithm | undefined;
|
|
1949
|
+
/**
|
|
1950
|
+
* <p>Container for the <code>TagSet</code> and <code>Tag</code> elements</p>
|
|
1951
|
+
* @public
|
|
1952
|
+
*/
|
|
1953
|
+
Tagging: Tagging | undefined;
|
|
1954
|
+
/**
|
|
1955
|
+
* <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
|
|
1956
|
+
* @public
|
|
1957
|
+
*/
|
|
1958
|
+
ExpectedBucketOwner?: string | undefined;
|
|
1959
|
+
/**
|
|
1960
|
+
* <p>Confirms that the requester knows that they will be charged for the request. Bucket
|
|
1961
|
+
* owners need not specify this parameter in their requests. If either the source or
|
|
1962
|
+
* destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding
|
|
1963
|
+
* charges to copy the object. For information about downloading objects from Requester Pays
|
|
1964
|
+
* buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in
|
|
1965
|
+
* Requester Pays Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1966
|
+
* <note>
|
|
1967
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
1968
|
+
* </note>
|
|
1969
|
+
* @public
|
|
1970
|
+
*/
|
|
1971
|
+
RequestPayer?: RequestPayer | undefined;
|
|
1972
|
+
}
|
|
1973
|
+
/**
|
|
1974
|
+
* @public
|
|
1975
|
+
*/
|
|
1976
|
+
export interface PutPublicAccessBlockRequest {
|
|
1977
|
+
/**
|
|
1978
|
+
* <p>The name of the Amazon S3 bucket whose <code>PublicAccessBlock</code> configuration you want
|
|
1979
|
+
* to set.</p>
|
|
1980
|
+
* <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
|
|
1981
|
+
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
1982
|
+
* @public
|
|
1983
|
+
*/
|
|
1984
|
+
Bucket: string | undefined;
|
|
1985
|
+
/**
|
|
1986
|
+
* <p>The MD5 hash of the <code>PutPublicAccessBlock</code> request body. </p>
|
|
1987
|
+
* <p>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</p>
|
|
1988
|
+
* @public
|
|
1989
|
+
*/
|
|
1990
|
+
ContentMD5?: string | undefined;
|
|
1991
|
+
/**
|
|
1992
|
+
* <p>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any
|
|
1993
|
+
* additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or
|
|
1994
|
+
* <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more
|
|
1995
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
|
|
1996
|
+
* the <i>Amazon S3 User Guide</i>.</p>
|
|
1997
|
+
* <p>If you provide an individual checksum, Amazon S3 ignores any provided
|
|
1998
|
+
* <code>ChecksumAlgorithm</code> parameter.</p>
|
|
1999
|
+
* @public
|
|
2000
|
+
*/
|
|
2001
|
+
ChecksumAlgorithm?: ChecksumAlgorithm | undefined;
|
|
2002
|
+
/**
|
|
2003
|
+
* <p>The <code>PublicAccessBlock</code> configuration that you want to apply to this Amazon S3
|
|
2004
|
+
* bucket. You can enable the configuration options in any combination. For more information
|
|
2005
|
+
* about when Amazon S3 considers a bucket or object public, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status">The Meaning of "Public"</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
2006
|
+
* @public
|
|
2007
|
+
*/
|
|
2008
|
+
PublicAccessBlockConfiguration: PublicAccessBlockConfiguration | undefined;
|
|
2009
|
+
/**
|
|
2010
|
+
* <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
|
|
2011
|
+
* @public
|
|
2012
|
+
*/
|
|
2013
|
+
ExpectedBucketOwner?: string | undefined;
|
|
2014
|
+
}
|
|
2015
|
+
/**
|
|
2016
|
+
* <p>This action is not allowed against this storage tier.</p>
|
|
2017
|
+
* @public
|
|
2018
|
+
*/
|
|
2019
|
+
export declare class ObjectAlreadyInActiveTierError extends __BaseException {
|
|
2020
|
+
readonly name: "ObjectAlreadyInActiveTierError";
|
|
2021
|
+
readonly $fault: "client";
|
|
2022
|
+
/**
|
|
2023
|
+
* @internal
|
|
2024
|
+
*/
|
|
2025
|
+
constructor(opts: __ExceptionOptionType<ObjectAlreadyInActiveTierError, __BaseException>);
|
|
2026
|
+
}
|
|
2027
|
+
/**
|
|
2028
|
+
* @public
|
|
2029
|
+
*/
|
|
2030
|
+
export interface RestoreObjectOutput {
|
|
2031
|
+
/**
|
|
2032
|
+
* <p>If present, indicates that the requester was successfully charged for the
|
|
2033
|
+
* request.</p>
|
|
2034
|
+
* <note>
|
|
2035
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
2036
|
+
* </note>
|
|
2037
|
+
* @public
|
|
2038
|
+
*/
|
|
2039
|
+
RequestCharged?: RequestCharged | undefined;
|
|
2040
|
+
/**
|
|
2041
|
+
* <p>Indicates the path in the provided S3 output location where Select results will be
|
|
2042
|
+
* restored to.</p>
|
|
2043
|
+
* @public
|
|
2044
|
+
*/
|
|
2045
|
+
RestoreOutputPath?: string | undefined;
|
|
2046
|
+
}
|
|
2047
|
+
/**
|
|
2048
|
+
* @public
|
|
2049
|
+
* @enum
|
|
2050
|
+
*/
|
|
2051
|
+
export declare const Tier: {
|
|
2052
|
+
readonly Bulk: "Bulk";
|
|
2053
|
+
readonly Expedited: "Expedited";
|
|
2054
|
+
readonly Standard: "Standard";
|
|
2055
|
+
};
|
|
2056
|
+
/**
|
|
2057
|
+
* @public
|
|
2058
|
+
*/
|
|
2059
|
+
export type Tier = (typeof Tier)[keyof typeof Tier];
|
|
2060
|
+
/**
|
|
2061
|
+
* <p>Container for S3 Glacier job parameters.</p>
|
|
2062
|
+
* @public
|
|
2063
|
+
*/
|
|
2064
|
+
export interface GlacierJobParameters {
|
|
2065
|
+
/**
|
|
2066
|
+
* <p>Retrieval tier at which the restore will be processed.</p>
|
|
2067
|
+
* @public
|
|
2068
|
+
*/
|
|
2069
|
+
Tier: Tier | undefined;
|
|
2070
|
+
}
|
|
2071
|
+
/**
|
|
2072
|
+
* <p>Contains the type of server-side encryption used.</p>
|
|
2073
|
+
* @public
|
|
2074
|
+
*/
|
|
2075
|
+
export interface Encryption {
|
|
2076
|
+
/**
|
|
2077
|
+
* <p>The server-side encryption algorithm used when storing job results in Amazon S3 (for example,
|
|
2078
|
+
* AES256, <code>aws:kms</code>).</p>
|
|
2079
|
+
* @public
|
|
2080
|
+
*/
|
|
2081
|
+
EncryptionType: ServerSideEncryption | undefined;
|
|
2082
|
+
/**
|
|
2083
|
+
* <p>If the encryption type is <code>aws:kms</code>, this optional value specifies the ID of
|
|
2084
|
+
* the symmetric encryption customer managed key to use for encryption of job results. Amazon S3 only
|
|
2085
|
+
* supports symmetric encryption KMS keys. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Asymmetric keys in KMS</a> in the <i>Amazon Web Services Key Management Service
|
|
2086
|
+
* Developer Guide</i>.</p>
|
|
2087
|
+
* @public
|
|
2088
|
+
*/
|
|
2089
|
+
KMSKeyId?: string | undefined;
|
|
2090
|
+
/**
|
|
2091
|
+
* <p>If the encryption type is <code>aws:kms</code>, this optional value can be used to
|
|
2092
|
+
* specify the encryption context for the restore results.</p>
|
|
2093
|
+
* @public
|
|
2094
|
+
*/
|
|
2095
|
+
KMSContext?: string | undefined;
|
|
2096
|
+
}
|
|
2097
|
+
/**
|
|
2098
|
+
* <p>A metadata key-value pair to store with an object.</p>
|
|
2099
|
+
* @public
|
|
2100
|
+
*/
|
|
2101
|
+
export interface MetadataEntry {
|
|
2102
|
+
/**
|
|
2103
|
+
* <p>Name of the object.</p>
|
|
2104
|
+
* @public
|
|
2105
|
+
*/
|
|
2106
|
+
Name?: string | undefined;
|
|
2107
|
+
/**
|
|
2108
|
+
* <p>Value of the object.</p>
|
|
2109
|
+
* @public
|
|
2110
|
+
*/
|
|
2111
|
+
Value?: string | undefined;
|
|
2112
|
+
}
|
|
2113
|
+
/**
|
|
2114
|
+
* <p>Describes an Amazon S3 location that will receive the results of the restore request.</p>
|
|
2115
|
+
* @public
|
|
2116
|
+
*/
|
|
2117
|
+
export interface S3Location {
|
|
2118
|
+
/**
|
|
2119
|
+
* <p>The name of the bucket where the restore results will be placed.</p>
|
|
2120
|
+
* @public
|
|
2121
|
+
*/
|
|
2122
|
+
BucketName: string | undefined;
|
|
2123
|
+
/**
|
|
2124
|
+
* <p>The prefix that is prepended to the restore results for this request.</p>
|
|
2125
|
+
* @public
|
|
2126
|
+
*/
|
|
2127
|
+
Prefix: string | undefined;
|
|
2128
|
+
/**
|
|
2129
|
+
* <p>Contains the type of server-side encryption used.</p>
|
|
2130
|
+
* @public
|
|
2131
|
+
*/
|
|
2132
|
+
Encryption?: Encryption | undefined;
|
|
2133
|
+
/**
|
|
2134
|
+
* <p>The canned ACL to apply to the restore results.</p>
|
|
2135
|
+
* @public
|
|
2136
|
+
*/
|
|
2137
|
+
CannedACL?: ObjectCannedACL | undefined;
|
|
2138
|
+
/**
|
|
2139
|
+
* <p>A list of grants that control access to the staged results.</p>
|
|
2140
|
+
* @public
|
|
2141
|
+
*/
|
|
2142
|
+
AccessControlList?: Grant[] | undefined;
|
|
2143
|
+
/**
|
|
2144
|
+
* <p>The tag-set that is applied to the restore results.</p>
|
|
2145
|
+
* @public
|
|
2146
|
+
*/
|
|
2147
|
+
Tagging?: Tagging | undefined;
|
|
2148
|
+
/**
|
|
2149
|
+
* <p>A list of metadata to store with the restore results in S3.</p>
|
|
2150
|
+
* @public
|
|
2151
|
+
*/
|
|
2152
|
+
UserMetadata?: MetadataEntry[] | undefined;
|
|
2153
|
+
/**
|
|
2154
|
+
* <p>The class of storage used to store the restore results.</p>
|
|
2155
|
+
* @public
|
|
2156
|
+
*/
|
|
2157
|
+
StorageClass?: StorageClass | undefined;
|
|
2158
|
+
}
|
|
2159
|
+
/**
|
|
2160
|
+
* <p>Describes the location where the restore job's output is stored.</p>
|
|
2161
|
+
* @public
|
|
2162
|
+
*/
|
|
2163
|
+
export interface OutputLocation {
|
|
2164
|
+
/**
|
|
2165
|
+
* <p>Describes an S3 location that will receive the results of the restore request.</p>
|
|
2166
|
+
* @public
|
|
2167
|
+
*/
|
|
2168
|
+
S3?: S3Location | undefined;
|
|
2169
|
+
}
|
|
2170
|
+
/**
|
|
2171
|
+
* @public
|
|
2172
|
+
* @enum
|
|
2173
|
+
*/
|
|
2174
|
+
export declare const ExpressionType: {
|
|
2175
|
+
readonly SQL: "SQL";
|
|
2176
|
+
};
|
|
2177
|
+
/**
|
|
2178
|
+
* @public
|
|
2179
|
+
*/
|
|
2180
|
+
export type ExpressionType = (typeof ExpressionType)[keyof typeof ExpressionType];
|
|
2181
|
+
/**
|
|
2182
|
+
* @public
|
|
2183
|
+
* @enum
|
|
2184
|
+
*/
|
|
2185
|
+
export declare const CompressionType: {
|
|
2186
|
+
readonly BZIP2: "BZIP2";
|
|
2187
|
+
readonly GZIP: "GZIP";
|
|
2188
|
+
readonly NONE: "NONE";
|
|
2189
|
+
};
|
|
2190
|
+
/**
|
|
2191
|
+
* @public
|
|
2192
|
+
*/
|
|
2193
|
+
export type CompressionType = (typeof CompressionType)[keyof typeof CompressionType];
|
|
2194
|
+
/**
|
|
2195
|
+
* @public
|
|
2196
|
+
* @enum
|
|
2197
|
+
*/
|
|
2198
|
+
export declare const FileHeaderInfo: {
|
|
2199
|
+
readonly IGNORE: "IGNORE";
|
|
2200
|
+
readonly NONE: "NONE";
|
|
2201
|
+
readonly USE: "USE";
|
|
2202
|
+
};
|
|
2203
|
+
/**
|
|
2204
|
+
* @public
|
|
2205
|
+
*/
|
|
2206
|
+
export type FileHeaderInfo = (typeof FileHeaderInfo)[keyof typeof FileHeaderInfo];
|
|
2207
|
+
/**
|
|
2208
|
+
* <p>Describes how an uncompressed comma-separated values (CSV)-formatted input object is
|
|
2209
|
+
* formatted.</p>
|
|
2210
|
+
* @public
|
|
2211
|
+
*/
|
|
2212
|
+
export interface CSVInput {
|
|
2213
|
+
/**
|
|
2214
|
+
* <p>Describes the first line of input. Valid values are:</p>
|
|
2215
|
+
* <ul>
|
|
2216
|
+
* <li>
|
|
2217
|
+
* <p>
|
|
2218
|
+
* <code>NONE</code>: First line is not a header.</p>
|
|
2219
|
+
* </li>
|
|
2220
|
+
* <li>
|
|
2221
|
+
* <p>
|
|
2222
|
+
* <code>IGNORE</code>: First line is a header, but you can't use the header values
|
|
2223
|
+
* to indicate the column in an expression. You can use column position (such as _1, _2,
|
|
2224
|
+
* …) to indicate the column (<code>SELECT s._1 FROM OBJECT s</code>).</p>
|
|
2225
|
+
* </li>
|
|
2226
|
+
* <li>
|
|
2227
|
+
* <p>
|
|
2228
|
+
* <code>Use</code>: First line is a header, and you can use the header value to
|
|
2229
|
+
* identify a column in an expression (<code>SELECT "name" FROM OBJECT</code>). </p>
|
|
2230
|
+
* </li>
|
|
2231
|
+
* </ul>
|
|
2232
|
+
* @public
|
|
2233
|
+
*/
|
|
2234
|
+
FileHeaderInfo?: FileHeaderInfo | undefined;
|
|
2235
|
+
/**
|
|
2236
|
+
* <p>A single character used to indicate that a row should be ignored when the character is
|
|
2237
|
+
* present at the start of that row. You can specify any character to indicate a comment line.
|
|
2238
|
+
* The default character is <code>#</code>.</p>
|
|
2239
|
+
* <p>Default: <code>#</code>
|
|
2240
|
+
* </p>
|
|
2241
|
+
* @public
|
|
2242
|
+
*/
|
|
2243
|
+
Comments?: string | undefined;
|
|
2244
|
+
/**
|
|
2245
|
+
* <p>A single character used for escaping the quotation mark character inside an already
|
|
2246
|
+
* escaped value. For example, the value <code>""" a , b """</code> is parsed as <code>" a , b
|
|
2247
|
+
* "</code>.</p>
|
|
2248
|
+
* @public
|
|
2249
|
+
*/
|
|
2250
|
+
QuoteEscapeCharacter?: string | undefined;
|
|
2251
|
+
/**
|
|
2252
|
+
* <p>A single character used to separate individual records in the input. Instead of the
|
|
2253
|
+
* default value, you can specify an arbitrary delimiter.</p>
|
|
2254
|
+
* @public
|
|
2255
|
+
*/
|
|
2256
|
+
RecordDelimiter?: string | undefined;
|
|
2257
|
+
/**
|
|
2258
|
+
* <p>A single character used to separate individual fields in a record. You can specify an
|
|
2259
|
+
* arbitrary delimiter.</p>
|
|
2260
|
+
* @public
|
|
2261
|
+
*/
|
|
2262
|
+
FieldDelimiter?: string | undefined;
|
|
2263
|
+
/**
|
|
2264
|
+
* <p>A single character used for escaping when the field delimiter is part of the value. For
|
|
2265
|
+
* example, if the value is <code>a, b</code>, Amazon S3 wraps this field value in quotation marks,
|
|
2266
|
+
* as follows: <code>" a , b "</code>.</p>
|
|
2267
|
+
* <p>Type: String</p>
|
|
2268
|
+
* <p>Default: <code>"</code>
|
|
2269
|
+
* </p>
|
|
2270
|
+
* <p>Ancestors: <code>CSV</code>
|
|
2271
|
+
* </p>
|
|
2272
|
+
* @public
|
|
2273
|
+
*/
|
|
2274
|
+
QuoteCharacter?: string | undefined;
|
|
2275
|
+
/**
|
|
2276
|
+
* <p>Specifies that CSV field values may contain quoted record delimiters and such records
|
|
2277
|
+
* should be allowed. Default value is FALSE. Setting this value to TRUE may lower
|
|
2278
|
+
* performance.</p>
|
|
2279
|
+
* @public
|
|
2280
|
+
*/
|
|
2281
|
+
AllowQuotedRecordDelimiter?: boolean | undefined;
|
|
2282
|
+
}
|
|
2283
|
+
/**
|
|
2284
|
+
* @public
|
|
2285
|
+
* @enum
|
|
2286
|
+
*/
|
|
2287
|
+
export declare const JSONType: {
|
|
2288
|
+
readonly DOCUMENT: "DOCUMENT";
|
|
2289
|
+
readonly LINES: "LINES";
|
|
2290
|
+
};
|
|
2291
|
+
/**
|
|
2292
|
+
* @public
|
|
2293
|
+
*/
|
|
2294
|
+
export type JSONType = (typeof JSONType)[keyof typeof JSONType];
|
|
2295
|
+
/**
|
|
2296
|
+
* <p>Specifies JSON as object's input serialization format.</p>
|
|
2297
|
+
* @public
|
|
2298
|
+
*/
|
|
2299
|
+
export interface JSONInput {
|
|
2300
|
+
/**
|
|
2301
|
+
* <p>The type of JSON. Valid values: Document, Lines.</p>
|
|
2302
|
+
* @public
|
|
2303
|
+
*/
|
|
2304
|
+
Type?: JSONType | undefined;
|
|
2305
|
+
}
|
|
2306
|
+
/**
|
|
2307
|
+
* <p>Container for Parquet.</p>
|
|
2308
|
+
* @public
|
|
2309
|
+
*/
|
|
2310
|
+
export interface ParquetInput {
|
|
2311
|
+
}
|
|
2312
|
+
/**
|
|
2313
|
+
* <p>Describes the serialization format of the object.</p>
|
|
2314
|
+
* @public
|
|
2315
|
+
*/
|
|
2316
|
+
export interface InputSerialization {
|
|
2317
|
+
/**
|
|
2318
|
+
* <p>Describes the serialization of a CSV-encoded object.</p>
|
|
2319
|
+
* @public
|
|
2320
|
+
*/
|
|
2321
|
+
CSV?: CSVInput | undefined;
|
|
2322
|
+
/**
|
|
2323
|
+
* <p>Specifies object's compression format. Valid values: NONE, GZIP, BZIP2. Default Value:
|
|
2324
|
+
* NONE.</p>
|
|
2325
|
+
* @public
|
|
2326
|
+
*/
|
|
2327
|
+
CompressionType?: CompressionType | undefined;
|
|
2328
|
+
/**
|
|
2329
|
+
* <p>Specifies JSON as object's input serialization format.</p>
|
|
2330
|
+
* @public
|
|
2331
|
+
*/
|
|
2332
|
+
JSON?: JSONInput | undefined;
|
|
2333
|
+
/**
|
|
2334
|
+
* <p>Specifies Parquet as object's input serialization format.</p>
|
|
2335
|
+
* @public
|
|
2336
|
+
*/
|
|
2337
|
+
Parquet?: ParquetInput | undefined;
|
|
2338
|
+
}
|
|
2339
|
+
/**
|
|
2340
|
+
* @public
|
|
2341
|
+
* @enum
|
|
2342
|
+
*/
|
|
2343
|
+
export declare const QuoteFields: {
|
|
2344
|
+
readonly ALWAYS: "ALWAYS";
|
|
2345
|
+
readonly ASNEEDED: "ASNEEDED";
|
|
2346
|
+
};
|
|
2347
|
+
/**
|
|
2348
|
+
* @public
|
|
2349
|
+
*/
|
|
2350
|
+
export type QuoteFields = (typeof QuoteFields)[keyof typeof QuoteFields];
|
|
2351
|
+
/**
|
|
2352
|
+
* <p>Describes how uncompressed comma-separated values (CSV)-formatted results are
|
|
2353
|
+
* formatted.</p>
|
|
2354
|
+
* @public
|
|
2355
|
+
*/
|
|
2356
|
+
export interface CSVOutput {
|
|
2357
|
+
/**
|
|
2358
|
+
* <p>Indicates whether to use quotation marks around output fields. </p>
|
|
2359
|
+
* <ul>
|
|
2360
|
+
* <li>
|
|
2361
|
+
* <p>
|
|
2362
|
+
* <code>ALWAYS</code>: Always use quotation marks for output fields.</p>
|
|
2363
|
+
* </li>
|
|
2364
|
+
* <li>
|
|
2365
|
+
* <p>
|
|
2366
|
+
* <code>ASNEEDED</code>: Use quotation marks for output fields when needed.</p>
|
|
2367
|
+
* </li>
|
|
2368
|
+
* </ul>
|
|
2369
|
+
* @public
|
|
2370
|
+
*/
|
|
2371
|
+
QuoteFields?: QuoteFields | undefined;
|
|
2372
|
+
/**
|
|
2373
|
+
* <p>The single character used for escaping the quote character inside an already escaped
|
|
2374
|
+
* value.</p>
|
|
2375
|
+
* @public
|
|
2376
|
+
*/
|
|
2377
|
+
QuoteEscapeCharacter?: string | undefined;
|
|
2378
|
+
/**
|
|
2379
|
+
* <p>A single character used to separate individual records in the output. Instead of the
|
|
2380
|
+
* default value, you can specify an arbitrary delimiter.</p>
|
|
2381
|
+
* @public
|
|
2382
|
+
*/
|
|
2383
|
+
RecordDelimiter?: string | undefined;
|
|
2384
|
+
/**
|
|
2385
|
+
* <p>The value used to separate individual fields in a record. You can specify an arbitrary
|
|
2386
|
+
* delimiter.</p>
|
|
2387
|
+
* @public
|
|
2388
|
+
*/
|
|
2389
|
+
FieldDelimiter?: string | undefined;
|
|
2390
|
+
/**
|
|
2391
|
+
* <p>A single character used for escaping when the field delimiter is part of the value. For
|
|
2392
|
+
* example, if the value is <code>a, b</code>, Amazon S3 wraps this field value in quotation marks,
|
|
2393
|
+
* as follows: <code>" a , b "</code>.</p>
|
|
2394
|
+
* @public
|
|
2395
|
+
*/
|
|
2396
|
+
QuoteCharacter?: string | undefined;
|
|
2397
|
+
}
|
|
2398
|
+
/**
|
|
2399
|
+
* <p>Specifies JSON as request's output serialization format.</p>
|
|
2400
|
+
* @public
|
|
2401
|
+
*/
|
|
2402
|
+
export interface JSONOutput {
|
|
2403
|
+
/**
|
|
2404
|
+
* <p>The value used to separate individual records in the output. If no value is specified,
|
|
2405
|
+
* Amazon S3 uses a newline character ('\n').</p>
|
|
2406
|
+
* @public
|
|
2407
|
+
*/
|
|
2408
|
+
RecordDelimiter?: string | undefined;
|
|
2409
|
+
}
|
|
2410
|
+
/**
|
|
2411
|
+
* <p>Describes how results of the Select job are serialized.</p>
|
|
2412
|
+
* @public
|
|
2413
|
+
*/
|
|
2414
|
+
export interface OutputSerialization {
|
|
2415
|
+
/**
|
|
2416
|
+
* <p>Describes the serialization of CSV-encoded Select results.</p>
|
|
2417
|
+
* @public
|
|
2418
|
+
*/
|
|
2419
|
+
CSV?: CSVOutput | undefined;
|
|
2420
|
+
/**
|
|
2421
|
+
* <p>Specifies JSON as request's output serialization format.</p>
|
|
2422
|
+
* @public
|
|
2423
|
+
*/
|
|
2424
|
+
JSON?: JSONOutput | undefined;
|
|
2425
|
+
}
|
|
2426
|
+
/**
|
|
2427
|
+
* <important>
|
|
2428
|
+
* <p>Amazon S3 Select is no longer available to new customers. Existing customers of Amazon S3 Select can continue to use the feature as usual. <a href="http://aws.amazon.com/blogs/storage/how-to-optimize-querying-your-data-in-amazon-s3/">Learn more</a>
|
|
2429
|
+
* </p>
|
|
2430
|
+
* </important>
|
|
2431
|
+
* <p>Describes the parameters for Select job types.</p>
|
|
2432
|
+
* <p>Learn <a href="http://aws.amazon.com/blogs/storage/how-to-optimize-querying-your-data-in-amazon-s3/">How to optimize querying your data in Amazon S3</a> using
|
|
2433
|
+
* <a href="https://docs.aws.amazon.com/athena/latest/ug/what-is.html">Amazon Athena</a>, <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/transforming-objects.html">S3 Object Lambda</a>, or client-side filtering.</p>
|
|
2434
|
+
* @public
|
|
2435
|
+
*/
|
|
2436
|
+
export interface SelectParameters {
|
|
2437
|
+
/**
|
|
2438
|
+
* <p>Describes the serialization format of the object.</p>
|
|
2439
|
+
* @public
|
|
2440
|
+
*/
|
|
2441
|
+
InputSerialization: InputSerialization | undefined;
|
|
2442
|
+
/**
|
|
2443
|
+
* <p>The type of the provided expression (for example, SQL).</p>
|
|
2444
|
+
* @public
|
|
2445
|
+
*/
|
|
2446
|
+
ExpressionType: ExpressionType | undefined;
|
|
2447
|
+
/**
|
|
2448
|
+
* <important>
|
|
2449
|
+
* <p>Amazon S3 Select is no longer available to new customers. Existing customers of Amazon S3 Select can continue to use the feature as usual. <a href="http://aws.amazon.com/blogs/storage/how-to-optimize-querying-your-data-in-amazon-s3/">Learn more</a>
|
|
2450
|
+
* </p>
|
|
2451
|
+
* </important>
|
|
2452
|
+
* <p>The expression that is used to query the object.</p>
|
|
2453
|
+
* @public
|
|
2454
|
+
*/
|
|
2455
|
+
Expression: string | undefined;
|
|
2456
|
+
/**
|
|
2457
|
+
* <p>Describes how the results of the Select job are serialized.</p>
|
|
2458
|
+
* @public
|
|
2459
|
+
*/
|
|
2460
|
+
OutputSerialization: OutputSerialization | undefined;
|
|
2461
|
+
}
|
|
2462
|
+
/**
|
|
2463
|
+
* @public
|
|
2464
|
+
* @enum
|
|
2465
|
+
*/
|
|
2466
|
+
export declare const RestoreRequestType: {
|
|
2467
|
+
readonly SELECT: "SELECT";
|
|
2468
|
+
};
|
|
2469
|
+
/**
|
|
2470
|
+
* @public
|
|
2471
|
+
*/
|
|
2472
|
+
export type RestoreRequestType = (typeof RestoreRequestType)[keyof typeof RestoreRequestType];
|
|
2473
|
+
/**
|
|
2474
|
+
* <p>Container for restore job parameters.</p>
|
|
2475
|
+
* @public
|
|
2476
|
+
*/
|
|
2477
|
+
export interface RestoreRequest {
|
|
2478
|
+
/**
|
|
2479
|
+
* <p>Lifetime of the active copy in days. Do not use with restores that specify
|
|
2480
|
+
* <code>OutputLocation</code>.</p>
|
|
2481
|
+
* <p>The Days element is required for regular restores, and must not be provided for select
|
|
2482
|
+
* requests.</p>
|
|
2483
|
+
* @public
|
|
2484
|
+
*/
|
|
2485
|
+
Days?: number | undefined;
|
|
2486
|
+
/**
|
|
2487
|
+
* <p>S3 Glacier related parameters pertaining to this job. Do not use with restores that
|
|
2488
|
+
* specify <code>OutputLocation</code>.</p>
|
|
2489
|
+
* @public
|
|
2490
|
+
*/
|
|
2491
|
+
GlacierJobParameters?: GlacierJobParameters | undefined;
|
|
2492
|
+
/**
|
|
2493
|
+
* <important>
|
|
2494
|
+
* <p>Amazon S3 Select is no longer available to new customers. Existing customers of Amazon S3 Select can continue to use the feature as usual. <a href="http://aws.amazon.com/blogs/storage/how-to-optimize-querying-your-data-in-amazon-s3/">Learn more</a>
|
|
2495
|
+
* </p>
|
|
2496
|
+
* </important>
|
|
2497
|
+
* <p>Type of restore request.</p>
|
|
2498
|
+
* @public
|
|
2499
|
+
*/
|
|
2500
|
+
Type?: RestoreRequestType | undefined;
|
|
2501
|
+
/**
|
|
2502
|
+
* <p>Retrieval tier at which the restore will be processed.</p>
|
|
2503
|
+
* @public
|
|
2504
|
+
*/
|
|
2505
|
+
Tier?: Tier | undefined;
|
|
2506
|
+
/**
|
|
2507
|
+
* <p>The optional description for the job.</p>
|
|
2508
|
+
* @public
|
|
2509
|
+
*/
|
|
2510
|
+
Description?: string | undefined;
|
|
2511
|
+
/**
|
|
2512
|
+
* <important>
|
|
2513
|
+
* <p>Amazon S3 Select is no longer available to new customers. Existing customers of Amazon S3 Select can continue to use the feature as usual. <a href="http://aws.amazon.com/blogs/storage/how-to-optimize-querying-your-data-in-amazon-s3/">Learn more</a>
|
|
2514
|
+
* </p>
|
|
2515
|
+
* </important>
|
|
2516
|
+
* <p>Describes the parameters for Select job types.</p>
|
|
2517
|
+
* @public
|
|
2518
|
+
*/
|
|
2519
|
+
SelectParameters?: SelectParameters | undefined;
|
|
2520
|
+
/**
|
|
2521
|
+
* <p>Describes the location where the restore job's output is stored.</p>
|
|
2522
|
+
* @public
|
|
2523
|
+
*/
|
|
2524
|
+
OutputLocation?: OutputLocation | undefined;
|
|
2525
|
+
}
|
|
2526
|
+
/**
|
|
2527
|
+
* @public
|
|
2528
|
+
*/
|
|
2529
|
+
export interface RestoreObjectRequest {
|
|
2530
|
+
/**
|
|
2531
|
+
* <p>The bucket name containing the object to restore. </p>
|
|
2532
|
+
* <p>
|
|
2533
|
+
* <b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
2534
|
+
* <p>
|
|
2535
|
+
* <b>S3 on Outposts</b> - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code>
|
|
2536
|
+
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
2537
|
+
* <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
|
|
2538
|
+
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
2539
|
+
* @public
|
|
2540
|
+
*/
|
|
2541
|
+
Bucket: string | undefined;
|
|
2542
|
+
/**
|
|
2543
|
+
* <p>Object key for which the action was initiated.</p>
|
|
2544
|
+
* @public
|
|
2545
|
+
*/
|
|
2546
|
+
Key: string | undefined;
|
|
2547
|
+
/**
|
|
2548
|
+
* <p>VersionId used to reference a specific version of the object.</p>
|
|
2549
|
+
* @public
|
|
2550
|
+
*/
|
|
2551
|
+
VersionId?: string | undefined;
|
|
2552
|
+
/**
|
|
2553
|
+
* <p>Container for restore job parameters.</p>
|
|
2554
|
+
* @public
|
|
2555
|
+
*/
|
|
2556
|
+
RestoreRequest?: RestoreRequest | undefined;
|
|
2557
|
+
/**
|
|
2558
|
+
* <p>Confirms that the requester knows that they will be charged for the request. Bucket
|
|
2559
|
+
* owners need not specify this parameter in their requests. If either the source or
|
|
2560
|
+
* destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding
|
|
2561
|
+
* charges to copy the object. For information about downloading objects from Requester Pays
|
|
2562
|
+
* buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in
|
|
2563
|
+
* Requester Pays Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
2564
|
+
* <note>
|
|
2565
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
2566
|
+
* </note>
|
|
2567
|
+
* @public
|
|
2568
|
+
*/
|
|
2569
|
+
RequestPayer?: RequestPayer | undefined;
|
|
2570
|
+
/**
|
|
2571
|
+
* <p>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any
|
|
2572
|
+
* additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or
|
|
2573
|
+
* <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more
|
|
2574
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
|
|
2575
|
+
* the <i>Amazon S3 User Guide</i>.</p>
|
|
2576
|
+
* <p>If you provide an individual checksum, Amazon S3 ignores any provided
|
|
2577
|
+
* <code>ChecksumAlgorithm</code> parameter.</p>
|
|
2578
|
+
* @public
|
|
2579
|
+
*/
|
|
2580
|
+
ChecksumAlgorithm?: ChecksumAlgorithm | undefined;
|
|
2581
|
+
/**
|
|
2582
|
+
* <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
|
|
2583
|
+
* @public
|
|
2584
|
+
*/
|
|
2585
|
+
ExpectedBucketOwner?: string | undefined;
|
|
2586
|
+
}
|
|
2587
|
+
/**
|
|
2588
|
+
* <p></p>
|
|
2589
|
+
* @public
|
|
2590
|
+
*/
|
|
2591
|
+
export interface ContinuationEvent {
|
|
2592
|
+
}
|
|
2593
|
+
/**
|
|
2594
|
+
* <p>A message that indicates the request is complete and no more messages will be sent. You
|
|
2595
|
+
* should not assume that the request is complete until the client receives an
|
|
2596
|
+
* <code>EndEvent</code>.</p>
|
|
2597
|
+
* @public
|
|
2598
|
+
*/
|
|
2599
|
+
export interface EndEvent {
|
|
2600
|
+
}
|
|
2601
|
+
/**
|
|
2602
|
+
* <p>This data type contains information about progress of an operation.</p>
|
|
2603
|
+
* @public
|
|
2604
|
+
*/
|
|
2605
|
+
export interface Progress {
|
|
2606
|
+
/**
|
|
2607
|
+
* <p>The current number of object bytes scanned.</p>
|
|
2608
|
+
* @public
|
|
2609
|
+
*/
|
|
2610
|
+
BytesScanned?: number | undefined;
|
|
2611
|
+
/**
|
|
2612
|
+
* <p>The current number of uncompressed object bytes processed.</p>
|
|
2613
|
+
* @public
|
|
2614
|
+
*/
|
|
2615
|
+
BytesProcessed?: number | undefined;
|
|
2616
|
+
/**
|
|
2617
|
+
* <p>The current number of bytes of records payload data returned.</p>
|
|
2618
|
+
* @public
|
|
2619
|
+
*/
|
|
2620
|
+
BytesReturned?: number | undefined;
|
|
2621
|
+
}
|
|
2622
|
+
/**
|
|
2623
|
+
* <p>This data type contains information about the progress event of an operation.</p>
|
|
2624
|
+
* @public
|
|
2625
|
+
*/
|
|
2626
|
+
export interface ProgressEvent {
|
|
2627
|
+
/**
|
|
2628
|
+
* <p>The Progress event details.</p>
|
|
2629
|
+
* @public
|
|
2630
|
+
*/
|
|
2631
|
+
Details?: Progress | undefined;
|
|
2632
|
+
}
|
|
2633
|
+
/**
|
|
2634
|
+
* <p>The container for the records event.</p>
|
|
2635
|
+
* @public
|
|
2636
|
+
*/
|
|
2637
|
+
export interface RecordsEvent {
|
|
2638
|
+
/**
|
|
2639
|
+
* <p>The byte array of partial, one or more result records. S3 Select doesn't guarantee that
|
|
2640
|
+
* a record will be self-contained in one record frame. To ensure continuous streaming of
|
|
2641
|
+
* data, S3 Select might split the same record across multiple record frames instead of
|
|
2642
|
+
* aggregating the results in memory. Some S3 clients (for example, the SDK for Java) handle this behavior by creating a <code>ByteStream</code> out of the response by
|
|
2643
|
+
* default. Other clients might not handle this behavior by default. In those cases, you must
|
|
2644
|
+
* aggregate the results on the client side and parse the response.</p>
|
|
2645
|
+
* @public
|
|
2646
|
+
*/
|
|
2647
|
+
Payload?: Uint8Array | undefined;
|
|
2648
|
+
}
|
|
2649
|
+
/**
|
|
2650
|
+
* <p>Container for the stats details.</p>
|
|
2651
|
+
* @public
|
|
2652
|
+
*/
|
|
2653
|
+
export interface Stats {
|
|
2654
|
+
/**
|
|
2655
|
+
* <p>The total number of object bytes scanned.</p>
|
|
2656
|
+
* @public
|
|
2657
|
+
*/
|
|
2658
|
+
BytesScanned?: number | undefined;
|
|
2659
|
+
/**
|
|
2660
|
+
* <p>The total number of uncompressed object bytes processed.</p>
|
|
2661
|
+
* @public
|
|
2662
|
+
*/
|
|
2663
|
+
BytesProcessed?: number | undefined;
|
|
2664
|
+
/**
|
|
2665
|
+
* <p>The total number of bytes of records payload data returned.</p>
|
|
2666
|
+
* @public
|
|
2667
|
+
*/
|
|
2668
|
+
BytesReturned?: number | undefined;
|
|
2669
|
+
}
|
|
2670
|
+
/**
|
|
2671
|
+
* <p>Container for the Stats Event.</p>
|
|
2672
|
+
* @public
|
|
2673
|
+
*/
|
|
2674
|
+
export interface StatsEvent {
|
|
2675
|
+
/**
|
|
2676
|
+
* <p>The Stats event details.</p>
|
|
2677
|
+
* @public
|
|
2678
|
+
*/
|
|
2679
|
+
Details?: Stats | undefined;
|
|
2680
|
+
}
|
|
2681
|
+
/**
|
|
2682
|
+
* <p>The container for selecting objects from a content event stream.</p>
|
|
2683
|
+
* @public
|
|
2684
|
+
*/
|
|
2685
|
+
export type SelectObjectContentEventStream = SelectObjectContentEventStream.ContMember | SelectObjectContentEventStream.EndMember | SelectObjectContentEventStream.ProgressMember | SelectObjectContentEventStream.RecordsMember | SelectObjectContentEventStream.StatsMember | SelectObjectContentEventStream.$UnknownMember;
|
|
2686
|
+
/**
|
|
2687
|
+
* @public
|
|
2688
|
+
*/
|
|
2689
|
+
export declare namespace SelectObjectContentEventStream {
|
|
2690
|
+
/**
|
|
2691
|
+
* <p>The Records Event.</p>
|
|
2692
|
+
* @public
|
|
2693
|
+
*/
|
|
2694
|
+
interface RecordsMember {
|
|
2695
|
+
Records: RecordsEvent;
|
|
2696
|
+
Stats?: never;
|
|
2697
|
+
Progress?: never;
|
|
2698
|
+
Cont?: never;
|
|
2699
|
+
End?: never;
|
|
2700
|
+
$unknown?: never;
|
|
2701
|
+
}
|
|
2702
|
+
/**
|
|
2703
|
+
* <p>The Stats Event.</p>
|
|
2704
|
+
* @public
|
|
2705
|
+
*/
|
|
2706
|
+
interface StatsMember {
|
|
2707
|
+
Records?: never;
|
|
2708
|
+
Stats: StatsEvent;
|
|
2709
|
+
Progress?: never;
|
|
2710
|
+
Cont?: never;
|
|
2711
|
+
End?: never;
|
|
2712
|
+
$unknown?: never;
|
|
2713
|
+
}
|
|
2714
|
+
/**
|
|
2715
|
+
* <p>The Progress Event.</p>
|
|
2716
|
+
* @public
|
|
2717
|
+
*/
|
|
2718
|
+
interface ProgressMember {
|
|
2719
|
+
Records?: never;
|
|
2720
|
+
Stats?: never;
|
|
2721
|
+
Progress: ProgressEvent;
|
|
2722
|
+
Cont?: never;
|
|
2723
|
+
End?: never;
|
|
2724
|
+
$unknown?: never;
|
|
2725
|
+
}
|
|
2726
|
+
/**
|
|
2727
|
+
* <p>The Continuation Event.</p>
|
|
2728
|
+
* @public
|
|
2729
|
+
*/
|
|
2730
|
+
interface ContMember {
|
|
2731
|
+
Records?: never;
|
|
2732
|
+
Stats?: never;
|
|
2733
|
+
Progress?: never;
|
|
2734
|
+
Cont: ContinuationEvent;
|
|
2735
|
+
End?: never;
|
|
2736
|
+
$unknown?: never;
|
|
2737
|
+
}
|
|
2738
|
+
/**
|
|
2739
|
+
* <p>The End Event.</p>
|
|
2740
|
+
* @public
|
|
2741
|
+
*/
|
|
2742
|
+
interface EndMember {
|
|
2743
|
+
Records?: never;
|
|
2744
|
+
Stats?: never;
|
|
2745
|
+
Progress?: never;
|
|
2746
|
+
Cont?: never;
|
|
2747
|
+
End: EndEvent;
|
|
2748
|
+
$unknown?: never;
|
|
2749
|
+
}
|
|
2750
|
+
/**
|
|
2751
|
+
* @public
|
|
2752
|
+
*/
|
|
2753
|
+
interface $UnknownMember {
|
|
2754
|
+
Records?: never;
|
|
2755
|
+
Stats?: never;
|
|
2756
|
+
Progress?: never;
|
|
2757
|
+
Cont?: never;
|
|
2758
|
+
End?: never;
|
|
2759
|
+
$unknown: [string, any];
|
|
2760
|
+
}
|
|
2761
|
+
interface Visitor<T> {
|
|
2762
|
+
Records: (value: RecordsEvent) => T;
|
|
2763
|
+
Stats: (value: StatsEvent) => T;
|
|
2764
|
+
Progress: (value: ProgressEvent) => T;
|
|
2765
|
+
Cont: (value: ContinuationEvent) => T;
|
|
2766
|
+
End: (value: EndEvent) => T;
|
|
2767
|
+
_: (name: string, value: any) => T;
|
|
2768
|
+
}
|
|
2769
|
+
const visit: <T>(value: SelectObjectContentEventStream, visitor: Visitor<T>) => T;
|
|
2770
|
+
}
|
|
2771
|
+
/**
|
|
2772
|
+
* @public
|
|
2773
|
+
*/
|
|
2774
|
+
export interface SelectObjectContentOutput {
|
|
2775
|
+
/**
|
|
2776
|
+
* <p>The array of results.</p>
|
|
2777
|
+
* @public
|
|
2778
|
+
*/
|
|
2779
|
+
Payload?: AsyncIterable<SelectObjectContentEventStream> | undefined;
|
|
2780
|
+
}
|
|
2781
|
+
/**
|
|
2782
|
+
* <p>Container for specifying if periodic <code>QueryProgress</code> messages should be
|
|
2783
|
+
* sent.</p>
|
|
2784
|
+
* @public
|
|
2785
|
+
*/
|
|
2786
|
+
export interface RequestProgress {
|
|
2787
|
+
/**
|
|
2788
|
+
* <p>Specifies whether periodic QueryProgress frames should be sent. Valid values: TRUE,
|
|
2789
|
+
* FALSE. Default value: FALSE.</p>
|
|
2790
|
+
* @public
|
|
2791
|
+
*/
|
|
2792
|
+
Enabled?: boolean | undefined;
|
|
2793
|
+
}
|
|
2794
|
+
/**
|
|
2795
|
+
* <p>Specifies the byte range of the object to get the records from. A record is processed
|
|
2796
|
+
* when its first byte is contained by the range. This parameter is optional, but when
|
|
2797
|
+
* specified, it must not be empty. See RFC 2616, Section 14.35.1 about how to specify the
|
|
2798
|
+
* start and end of the range.</p>
|
|
2799
|
+
* @public
|
|
2800
|
+
*/
|
|
2801
|
+
export interface ScanRange {
|
|
2802
|
+
/**
|
|
2803
|
+
* <p>Specifies the start of the byte range. This parameter is optional. Valid values:
|
|
2804
|
+
* non-negative integers. The default value is 0. If only <code>start</code> is supplied, it
|
|
2805
|
+
* means scan from that point to the end of the file. For example,
|
|
2806
|
+
* <code><scanrange><start>50</start></scanrange></code> means scan
|
|
2807
|
+
* from byte 50 until the end of the file.</p>
|
|
2808
|
+
* @public
|
|
2809
|
+
*/
|
|
2810
|
+
Start?: number | undefined;
|
|
2811
|
+
/**
|
|
2812
|
+
* <p>Specifies the end of the byte range. This parameter is optional. Valid values:
|
|
2813
|
+
* non-negative integers. The default value is one less than the size of the object being
|
|
2814
|
+
* queried. If only the End parameter is supplied, it is interpreted to mean scan the last N
|
|
2815
|
+
* bytes of the file. For example,
|
|
2816
|
+
* <code><scanrange><end>50</end></scanrange></code> means scan the
|
|
2817
|
+
* last 50 bytes.</p>
|
|
2818
|
+
* @public
|
|
2819
|
+
*/
|
|
2820
|
+
End?: number | undefined;
|
|
2821
|
+
}
|
|
2822
|
+
/**
|
|
2823
|
+
* <note>
|
|
2824
|
+
* <p>Learn Amazon S3 Select is no longer available to new customers. Existing customers of Amazon S3 Select can continue to use the feature as usual. <a href="http://aws.amazon.com/blogs/storage/how-to-optimize-querying-your-data-in-amazon-s3/">Learn more</a>
|
|
2825
|
+
* </p>
|
|
2826
|
+
* </note>
|
|
2827
|
+
* <p>Request to filter the contents of an Amazon S3 object based on a simple Structured Query
|
|
2828
|
+
* Language (SQL) statement. In the request, along with the SQL expression, you must specify a
|
|
2829
|
+
* data serialization format (JSON or CSV) of the object. Amazon S3 uses this to parse object data
|
|
2830
|
+
* into records. It returns only records that match the specified SQL expression. You must
|
|
2831
|
+
* also specify the data serialization format for the response. For more information, see
|
|
2832
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectSELECTContent.html">S3Select API Documentation</a>.</p>
|
|
2833
|
+
* @public
|
|
2834
|
+
*/
|
|
2835
|
+
export interface SelectObjectContentRequest {
|
|
2836
|
+
/**
|
|
2837
|
+
* <p>The S3 bucket.</p>
|
|
2838
|
+
* <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
|
|
2839
|
+
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
2840
|
+
* @public
|
|
2841
|
+
*/
|
|
2842
|
+
Bucket: string | undefined;
|
|
2843
|
+
/**
|
|
2844
|
+
* <p>The object key.</p>
|
|
2845
|
+
* @public
|
|
2846
|
+
*/
|
|
2847
|
+
Key: string | undefined;
|
|
2848
|
+
/**
|
|
2849
|
+
* <p>The server-side encryption (SSE) algorithm used to encrypt the object. This parameter is needed only when the object was created
|
|
2850
|
+
* using a checksum algorithm. For more information,
|
|
2851
|
+
* see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Protecting data using SSE-C keys</a> in the
|
|
2852
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
2853
|
+
* @public
|
|
2854
|
+
*/
|
|
2855
|
+
SSECustomerAlgorithm?: string | undefined;
|
|
2856
|
+
/**
|
|
2857
|
+
* <p>The server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm.
|
|
2858
|
+
* For more information, see
|
|
2859
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Protecting data using SSE-C keys</a> in the
|
|
2860
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
2861
|
+
* @public
|
|
2862
|
+
*/
|
|
2863
|
+
SSECustomerKey?: string | undefined;
|
|
2864
|
+
/**
|
|
2865
|
+
* <p>The MD5 server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum
|
|
2866
|
+
* algorithm. For more information,
|
|
2867
|
+
* see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Protecting data using SSE-C keys</a> in the
|
|
2868
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
2869
|
+
* @public
|
|
2870
|
+
*/
|
|
2871
|
+
SSECustomerKeyMD5?: string | undefined;
|
|
2872
|
+
/**
|
|
2873
|
+
* <p>The expression that is used to query the object.</p>
|
|
2874
|
+
* @public
|
|
2875
|
+
*/
|
|
2876
|
+
Expression: string | undefined;
|
|
2877
|
+
/**
|
|
2878
|
+
* <p>The type of the provided expression (for example, SQL).</p>
|
|
2879
|
+
* @public
|
|
2880
|
+
*/
|
|
2881
|
+
ExpressionType: ExpressionType | undefined;
|
|
2882
|
+
/**
|
|
2883
|
+
* <p>Specifies if periodic request progress information should be enabled.</p>
|
|
2884
|
+
* @public
|
|
2885
|
+
*/
|
|
2886
|
+
RequestProgress?: RequestProgress | undefined;
|
|
2887
|
+
/**
|
|
2888
|
+
* <p>Describes the format of the data in the object that is being queried.</p>
|
|
2889
|
+
* @public
|
|
2890
|
+
*/
|
|
2891
|
+
InputSerialization: InputSerialization | undefined;
|
|
2892
|
+
/**
|
|
2893
|
+
* <p>Describes the format of the data that you want Amazon S3 to return in response.</p>
|
|
2894
|
+
* @public
|
|
2895
|
+
*/
|
|
2896
|
+
OutputSerialization: OutputSerialization | undefined;
|
|
2897
|
+
/**
|
|
2898
|
+
* <p>Specifies the byte range of the object to get the records from. A record is processed
|
|
2899
|
+
* when its first byte is contained by the range. This parameter is optional, but when
|
|
2900
|
+
* specified, it must not be empty. See RFC 2616, Section 14.35.1 about how to specify the
|
|
2901
|
+
* start and end of the range.</p>
|
|
2902
|
+
* <p>
|
|
2903
|
+
* <code>ScanRange</code>may be used in the following ways:</p>
|
|
2904
|
+
* <ul>
|
|
2905
|
+
* <li>
|
|
2906
|
+
* <p>
|
|
2907
|
+
* <code><scanrange><start>50</start><end>100</end></scanrange></code>
|
|
2908
|
+
* - process only the records starting between the bytes 50 and 100 (inclusive, counting
|
|
2909
|
+
* from zero)</p>
|
|
2910
|
+
* </li>
|
|
2911
|
+
* <li>
|
|
2912
|
+
* <p>
|
|
2913
|
+
* <code><scanrange><start>50</start></scanrange></code> -
|
|
2914
|
+
* process only the records starting after the byte 50</p>
|
|
2915
|
+
* </li>
|
|
2916
|
+
* <li>
|
|
2917
|
+
* <p>
|
|
2918
|
+
* <code><scanrange><end>50</end></scanrange></code> -
|
|
2919
|
+
* process only the records within the last 50 bytes of the file.</p>
|
|
2920
|
+
* </li>
|
|
2921
|
+
* </ul>
|
|
2922
|
+
* @public
|
|
2923
|
+
*/
|
|
2924
|
+
ScanRange?: ScanRange | undefined;
|
|
2925
|
+
/**
|
|
2926
|
+
* <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
|
|
2927
|
+
* @public
|
|
2928
|
+
*/
|
|
2929
|
+
ExpectedBucketOwner?: string | undefined;
|
|
2930
|
+
}
|
|
2931
|
+
/**
|
|
2932
|
+
* @public
|
|
2933
|
+
*/
|
|
2934
|
+
export interface UploadPartOutput {
|
|
2935
|
+
/**
|
|
2936
|
+
* <p>The server-side encryption algorithm used when you store this object in Amazon S3 (for
|
|
2937
|
+
* example, <code>AES256</code>, <code>aws:kms</code>).</p>
|
|
2938
|
+
* @public
|
|
2939
|
+
*/
|
|
2940
|
+
ServerSideEncryption?: ServerSideEncryption | undefined;
|
|
2941
|
+
/**
|
|
2942
|
+
* <p>Entity tag for the uploaded object.</p>
|
|
2943
|
+
* @public
|
|
2944
|
+
*/
|
|
2945
|
+
ETag?: string | undefined;
|
|
2946
|
+
/**
|
|
2947
|
+
* <p>The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded
|
|
2948
|
+
* with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated
|
|
2949
|
+
* with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums">
|
|
2950
|
+
* Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
2951
|
+
* @public
|
|
2952
|
+
*/
|
|
2953
|
+
ChecksumCRC32?: string | undefined;
|
|
2954
|
+
/**
|
|
2955
|
+
* <p>The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded
|
|
2956
|
+
* with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated
|
|
2957
|
+
* with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums">
|
|
2958
|
+
* Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
2959
|
+
* @public
|
|
2960
|
+
*/
|
|
2961
|
+
ChecksumCRC32C?: string | undefined;
|
|
2962
|
+
/**
|
|
2963
|
+
* <p>The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded
|
|
2964
|
+
* with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated
|
|
2965
|
+
* with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums">
|
|
2966
|
+
* Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
2967
|
+
* @public
|
|
2968
|
+
*/
|
|
2969
|
+
ChecksumSHA1?: string | undefined;
|
|
2970
|
+
/**
|
|
2971
|
+
* <p>The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded
|
|
2972
|
+
* with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated
|
|
2973
|
+
* with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums">
|
|
2974
|
+
* Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
2975
|
+
* @public
|
|
2976
|
+
*/
|
|
2977
|
+
ChecksumSHA256?: string | undefined;
|
|
2978
|
+
/**
|
|
2979
|
+
* <p>If server-side encryption with a customer-provided encryption key was requested, the
|
|
2980
|
+
* response will include this header to confirm the encryption algorithm that's used.</p>
|
|
2981
|
+
* <note>
|
|
2982
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
2983
|
+
* </note>
|
|
2984
|
+
* @public
|
|
2985
|
+
*/
|
|
2986
|
+
SSECustomerAlgorithm?: string | undefined;
|
|
2987
|
+
/**
|
|
2988
|
+
* <p>If server-side encryption with a customer-provided encryption key was requested, the
|
|
2989
|
+
* response will include this header to provide the round-trip message integrity verification
|
|
2990
|
+
* of the customer-provided encryption key.</p>
|
|
2991
|
+
* <note>
|
|
2992
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
2993
|
+
* </note>
|
|
2994
|
+
* @public
|
|
2995
|
+
*/
|
|
2996
|
+
SSECustomerKeyMD5?: string | undefined;
|
|
2997
|
+
/**
|
|
2998
|
+
* <p>If present, indicates the ID of the KMS key that was used for object encryption.</p>
|
|
2999
|
+
* @public
|
|
3000
|
+
*/
|
|
3001
|
+
SSEKMSKeyId?: string | undefined;
|
|
3002
|
+
/**
|
|
3003
|
+
* <p>Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption
|
|
3004
|
+
* with Key Management Service (KMS) keys (SSE-KMS).</p>
|
|
3005
|
+
* @public
|
|
3006
|
+
*/
|
|
3007
|
+
BucketKeyEnabled?: boolean | undefined;
|
|
3008
|
+
/**
|
|
3009
|
+
* <p>If present, indicates that the requester was successfully charged for the
|
|
3010
|
+
* request.</p>
|
|
3011
|
+
* <note>
|
|
3012
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
3013
|
+
* </note>
|
|
3014
|
+
* @public
|
|
3015
|
+
*/
|
|
3016
|
+
RequestCharged?: RequestCharged | undefined;
|
|
3017
|
+
}
|
|
3018
|
+
/**
|
|
3019
|
+
* @public
|
|
3020
|
+
*/
|
|
3021
|
+
export interface UploadPartRequest {
|
|
3022
|
+
/**
|
|
3023
|
+
* <p>Object data.</p>
|
|
3024
|
+
* @public
|
|
3025
|
+
*/
|
|
3026
|
+
Body?: StreamingBlobTypes | undefined;
|
|
3027
|
+
/**
|
|
3028
|
+
* <p>The name of the bucket to which the multipart upload was initiated.</p>
|
|
3029
|
+
* <p>
|
|
3030
|
+
* <b>Directory buckets</b> -
|
|
3031
|
+
* When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code>
|
|
3032
|
+
* <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format <code>
|
|
3033
|
+
* <i>bucket-base-name</i>--<i>zone-id</i>--x-s3</code> (for example, <code>
|
|
3034
|
+
* <i>DOC-EXAMPLE-BUCKET</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming
|
|
3035
|
+
* restrictions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html">Directory bucket naming
|
|
3036
|
+
* rules</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
3037
|
+
* <p>
|
|
3038
|
+
* <b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
3039
|
+
* <note>
|
|
3040
|
+
* <p>Access points and Object Lambda access points are not supported by directory buckets.</p>
|
|
3041
|
+
* </note>
|
|
3042
|
+
* <p>
|
|
3043
|
+
* <b>S3 on Outposts</b> - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code>
|
|
3044
|
+
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
3045
|
+
* <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
|
|
3046
|
+
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
3047
|
+
* @public
|
|
3048
|
+
*/
|
|
3049
|
+
Bucket: string | undefined;
|
|
3050
|
+
/**
|
|
3051
|
+
* <p>Size of the body in bytes. This parameter is useful when the size of the body cannot be
|
|
3052
|
+
* determined automatically.</p>
|
|
3053
|
+
* @public
|
|
3054
|
+
*/
|
|
3055
|
+
ContentLength?: number | undefined;
|
|
3056
|
+
/**
|
|
3057
|
+
* <p>The base64-encoded 128-bit MD5 digest of the part data. This parameter is auto-populated
|
|
3058
|
+
* when using the command from the CLI. This parameter is required if object lock parameters
|
|
3059
|
+
* are specified.</p>
|
|
3060
|
+
* <note>
|
|
3061
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
3062
|
+
* </note>
|
|
3063
|
+
* @public
|
|
3064
|
+
*/
|
|
3065
|
+
ContentMD5?: string | undefined;
|
|
3066
|
+
/**
|
|
3067
|
+
* <p>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any
|
|
3068
|
+
* additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or
|
|
3069
|
+
* <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more
|
|
3070
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
|
|
3071
|
+
* the <i>Amazon S3 User Guide</i>.</p>
|
|
3072
|
+
* <p>If you provide an individual checksum, Amazon S3 ignores any provided
|
|
3073
|
+
* <code>ChecksumAlgorithm</code> parameter.</p>
|
|
3074
|
+
* <p>This checksum algorithm must be the same for all parts and it match the checksum value
|
|
3075
|
+
* supplied in the <code>CreateMultipartUpload</code> request.</p>
|
|
3076
|
+
* @public
|
|
3077
|
+
*/
|
|
3078
|
+
ChecksumAlgorithm?: ChecksumAlgorithm | undefined;
|
|
3079
|
+
/**
|
|
3080
|
+
* <p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.
|
|
3081
|
+
* This header specifies the base64-encoded, 32-bit CRC-32 checksum of the object. For more information, see
|
|
3082
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in the
|
|
3083
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
3084
|
+
* @public
|
|
3085
|
+
*/
|
|
3086
|
+
ChecksumCRC32?: string | undefined;
|
|
3087
|
+
/**
|
|
3088
|
+
* <p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.
|
|
3089
|
+
* This header specifies the base64-encoded, 32-bit CRC-32C checksum of the object. For more information, see
|
|
3090
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in the
|
|
3091
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
3092
|
+
* @public
|
|
3093
|
+
*/
|
|
3094
|
+
ChecksumCRC32C?: string | undefined;
|
|
3095
|
+
/**
|
|
3096
|
+
* <p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.
|
|
3097
|
+
* This header specifies the base64-encoded, 160-bit SHA-1 digest of the object. For more information, see
|
|
3098
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in the
|
|
3099
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
3100
|
+
* @public
|
|
3101
|
+
*/
|
|
3102
|
+
ChecksumSHA1?: string | undefined;
|
|
3103
|
+
/**
|
|
3104
|
+
* <p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.
|
|
3105
|
+
* This header specifies the base64-encoded, 256-bit SHA-256 digest of the object. For more information, see
|
|
3106
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in the
|
|
3107
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
3108
|
+
* @public
|
|
3109
|
+
*/
|
|
3110
|
+
ChecksumSHA256?: string | undefined;
|
|
3111
|
+
/**
|
|
3112
|
+
* <p>Object key for which the multipart upload was initiated.</p>
|
|
3113
|
+
* @public
|
|
3114
|
+
*/
|
|
3115
|
+
Key: string | undefined;
|
|
3116
|
+
/**
|
|
3117
|
+
* <p>Part number of part being uploaded. This is a positive integer between 1 and
|
|
3118
|
+
* 10,000.</p>
|
|
3119
|
+
* @public
|
|
3120
|
+
*/
|
|
3121
|
+
PartNumber: number | undefined;
|
|
3122
|
+
/**
|
|
3123
|
+
* <p>Upload ID identifying the multipart upload whose part is being uploaded.</p>
|
|
3124
|
+
* @public
|
|
3125
|
+
*/
|
|
3126
|
+
UploadId: string | undefined;
|
|
3127
|
+
/**
|
|
3128
|
+
* <p>Specifies the algorithm to use when encrypting the object (for example, AES256).</p>
|
|
3129
|
+
* <note>
|
|
3130
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
3131
|
+
* </note>
|
|
3132
|
+
* @public
|
|
3133
|
+
*/
|
|
3134
|
+
SSECustomerAlgorithm?: string | undefined;
|
|
3135
|
+
/**
|
|
3136
|
+
* <p>Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This
|
|
3137
|
+
* value is used to store the object and then it is discarded; Amazon S3 does not store the
|
|
3138
|
+
* encryption key. The key must be appropriate for use with the algorithm specified in the
|
|
3139
|
+
* <code>x-amz-server-side-encryption-customer-algorithm header</code>. This must be the
|
|
3140
|
+
* same encryption key specified in the initiate multipart upload request.</p>
|
|
3141
|
+
* <note>
|
|
3142
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
3143
|
+
* </note>
|
|
3144
|
+
* @public
|
|
3145
|
+
*/
|
|
3146
|
+
SSECustomerKey?: string | undefined;
|
|
3147
|
+
/**
|
|
3148
|
+
* <p>Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses
|
|
3149
|
+
* this header for a message integrity check to ensure that the encryption key was transmitted
|
|
3150
|
+
* without error.</p>
|
|
3151
|
+
* <note>
|
|
3152
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
3153
|
+
* </note>
|
|
3154
|
+
* @public
|
|
3155
|
+
*/
|
|
3156
|
+
SSECustomerKeyMD5?: string | undefined;
|
|
3157
|
+
/**
|
|
3158
|
+
* <p>Confirms that the requester knows that they will be charged for the request. Bucket
|
|
3159
|
+
* owners need not specify this parameter in their requests. If either the source or
|
|
3160
|
+
* destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding
|
|
3161
|
+
* charges to copy the object. For information about downloading objects from Requester Pays
|
|
3162
|
+
* buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in
|
|
3163
|
+
* Requester Pays Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
3164
|
+
* <note>
|
|
3165
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
3166
|
+
* </note>
|
|
3167
|
+
* @public
|
|
3168
|
+
*/
|
|
3169
|
+
RequestPayer?: RequestPayer | undefined;
|
|
3170
|
+
/**
|
|
3171
|
+
* <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
|
|
3172
|
+
* @public
|
|
3173
|
+
*/
|
|
3174
|
+
ExpectedBucketOwner?: string | undefined;
|
|
3175
|
+
}
|
|
3176
|
+
/**
|
|
3177
|
+
* <p>Container for all response elements.</p>
|
|
3178
|
+
* @public
|
|
3179
|
+
*/
|
|
3180
|
+
export interface CopyPartResult {
|
|
3181
|
+
/**
|
|
3182
|
+
* <p>Entity tag of the object.</p>
|
|
3183
|
+
* @public
|
|
3184
|
+
*/
|
|
3185
|
+
ETag?: string | undefined;
|
|
3186
|
+
/**
|
|
3187
|
+
* <p>Date and time at which the object was uploaded.</p>
|
|
3188
|
+
* @public
|
|
3189
|
+
*/
|
|
3190
|
+
LastModified?: Date | undefined;
|
|
3191
|
+
/**
|
|
3192
|
+
* <p>The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded
|
|
3193
|
+
* with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated
|
|
3194
|
+
* with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums">
|
|
3195
|
+
* Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
3196
|
+
* @public
|
|
3197
|
+
*/
|
|
3198
|
+
ChecksumCRC32?: string | undefined;
|
|
3199
|
+
/**
|
|
3200
|
+
* <p>The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded
|
|
3201
|
+
* with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated
|
|
3202
|
+
* with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums">
|
|
3203
|
+
* Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
3204
|
+
* @public
|
|
3205
|
+
*/
|
|
3206
|
+
ChecksumCRC32C?: string | undefined;
|
|
3207
|
+
/**
|
|
3208
|
+
* <p>The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded
|
|
3209
|
+
* with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated
|
|
3210
|
+
* with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums">
|
|
3211
|
+
* Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
3212
|
+
* @public
|
|
3213
|
+
*/
|
|
3214
|
+
ChecksumSHA1?: string | undefined;
|
|
3215
|
+
/**
|
|
3216
|
+
* <p>The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded
|
|
3217
|
+
* with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated
|
|
3218
|
+
* with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums">
|
|
3219
|
+
* Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
3220
|
+
* @public
|
|
3221
|
+
*/
|
|
3222
|
+
ChecksumSHA256?: string | undefined;
|
|
3223
|
+
}
|
|
3224
|
+
/**
|
|
3225
|
+
* @public
|
|
3226
|
+
*/
|
|
3227
|
+
export interface UploadPartCopyOutput {
|
|
3228
|
+
/**
|
|
3229
|
+
* <p>The version of the source object that was copied, if you have enabled versioning on the
|
|
3230
|
+
* source bucket.</p>
|
|
3231
|
+
* <note>
|
|
3232
|
+
* <p>This functionality is not supported when the source object is in a directory bucket.</p>
|
|
3233
|
+
* </note>
|
|
3234
|
+
* @public
|
|
3235
|
+
*/
|
|
3236
|
+
CopySourceVersionId?: string | undefined;
|
|
3237
|
+
/**
|
|
3238
|
+
* <p>Container for all response elements.</p>
|
|
3239
|
+
* @public
|
|
3240
|
+
*/
|
|
3241
|
+
CopyPartResult?: CopyPartResult | undefined;
|
|
3242
|
+
/**
|
|
3243
|
+
* <p>The server-side encryption algorithm used when you store this object in Amazon S3 (for
|
|
3244
|
+
* example, <code>AES256</code>, <code>aws:kms</code>).</p>
|
|
3245
|
+
* @public
|
|
3246
|
+
*/
|
|
3247
|
+
ServerSideEncryption?: ServerSideEncryption | undefined;
|
|
3248
|
+
/**
|
|
3249
|
+
* <p>If server-side encryption with a customer-provided encryption key was requested, the
|
|
3250
|
+
* response will include this header to confirm the encryption algorithm that's used.</p>
|
|
3251
|
+
* <note>
|
|
3252
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
3253
|
+
* </note>
|
|
3254
|
+
* @public
|
|
3255
|
+
*/
|
|
3256
|
+
SSECustomerAlgorithm?: string | undefined;
|
|
3257
|
+
/**
|
|
3258
|
+
* <p>If server-side encryption with a customer-provided encryption key was requested, the
|
|
3259
|
+
* response will include this header to provide the round-trip message integrity verification
|
|
3260
|
+
* of the customer-provided encryption key.</p>
|
|
3261
|
+
* <note>
|
|
3262
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
3263
|
+
* </note>
|
|
3264
|
+
* @public
|
|
3265
|
+
*/
|
|
3266
|
+
SSECustomerKeyMD5?: string | undefined;
|
|
3267
|
+
/**
|
|
3268
|
+
* <p>If present, indicates the ID of the KMS key that was used for object encryption.</p>
|
|
3269
|
+
* @public
|
|
3270
|
+
*/
|
|
3271
|
+
SSEKMSKeyId?: string | undefined;
|
|
3272
|
+
/**
|
|
3273
|
+
* <p>Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption
|
|
3274
|
+
* with Key Management Service (KMS) keys (SSE-KMS).</p>
|
|
3275
|
+
* @public
|
|
3276
|
+
*/
|
|
3277
|
+
BucketKeyEnabled?: boolean | undefined;
|
|
3278
|
+
/**
|
|
3279
|
+
* <p>If present, indicates that the requester was successfully charged for the
|
|
3280
|
+
* request.</p>
|
|
3281
|
+
* <note>
|
|
3282
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
3283
|
+
* </note>
|
|
3284
|
+
* @public
|
|
3285
|
+
*/
|
|
3286
|
+
RequestCharged?: RequestCharged | undefined;
|
|
3287
|
+
}
|
|
3288
|
+
/**
|
|
3289
|
+
* @public
|
|
3290
|
+
*/
|
|
3291
|
+
export interface UploadPartCopyRequest {
|
|
3292
|
+
/**
|
|
3293
|
+
* <p>The bucket name.</p>
|
|
3294
|
+
* <p>
|
|
3295
|
+
* <b>Directory buckets</b> - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code>
|
|
3296
|
+
* <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format <code>
|
|
3297
|
+
* <i>bucket-base-name</i>--<i>zone-id</i>--x-s3</code> (for example, <code>
|
|
3298
|
+
* <i>DOC-EXAMPLE-BUCKET</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming
|
|
3299
|
+
* restrictions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html">Directory bucket naming
|
|
3300
|
+
* rules</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
3301
|
+
* <note>
|
|
3302
|
+
* <p>Copying objects across different Amazon Web Services Regions isn't supported when the source or destination bucket is in Amazon Web Services Local Zones. The source and destination buckets must have the same parent Amazon Web Services Region. Otherwise,
|
|
3303
|
+
* you get an HTTP <code>400 Bad Request</code> error with the error code <code>InvalidRequest</code>.</p>
|
|
3304
|
+
* </note>
|
|
3305
|
+
* <p>
|
|
3306
|
+
* <b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
3307
|
+
* <note>
|
|
3308
|
+
* <p>Access points and Object Lambda access points are not supported by directory buckets.</p>
|
|
3309
|
+
* </note>
|
|
3310
|
+
* <p>
|
|
3311
|
+
* <b>S3 on Outposts</b> - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code>
|
|
3312
|
+
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
3313
|
+
* <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
|
|
3314
|
+
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
3315
|
+
* @public
|
|
3316
|
+
*/
|
|
3317
|
+
Bucket: string | undefined;
|
|
3318
|
+
/**
|
|
3319
|
+
* <p>Specifies the source object for the copy operation. You specify the value in one of two
|
|
3320
|
+
* formats, depending on whether you want to access the source object through an <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html">access point</a>:</p>
|
|
3321
|
+
* <ul>
|
|
3322
|
+
* <li>
|
|
3323
|
+
* <p>For objects not accessed through an access point, specify the name of the source bucket
|
|
3324
|
+
* and key of the source object, separated by a slash (/). For example, to copy the
|
|
3325
|
+
* object <code>reports/january.pdf</code> from the bucket
|
|
3326
|
+
* <code>awsexamplebucket</code>, use <code>awsexamplebucket/reports/january.pdf</code>.
|
|
3327
|
+
* The value must be URL-encoded.</p>
|
|
3328
|
+
* </li>
|
|
3329
|
+
* <li>
|
|
3330
|
+
* <p>For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format <code>arn:aws:s3:<Region>:<account-id>:accesspoint/<access-point-name>/object/<key></code>. For example, to copy the object <code>reports/january.pdf</code> through access point <code>my-access-point</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf</code>. The value must be URL encoded.</p>
|
|
3331
|
+
* <note>
|
|
3332
|
+
* <ul>
|
|
3333
|
+
* <li>
|
|
3334
|
+
* <p>Amazon S3 supports copy operations using Access points only when the source and destination buckets are in the same Amazon Web Services Region.</p>
|
|
3335
|
+
* </li>
|
|
3336
|
+
* <li>
|
|
3337
|
+
* <p>Access points are not supported by directory buckets.</p>
|
|
3338
|
+
* </li>
|
|
3339
|
+
* </ul>
|
|
3340
|
+
* </note>
|
|
3341
|
+
* <p>Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format <code>arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/object/<key></code>. For example, to copy the object <code>reports/january.pdf</code> through outpost <code>my-outpost</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf</code>. The value must be URL-encoded. </p>
|
|
3342
|
+
* </li>
|
|
3343
|
+
* </ul>
|
|
3344
|
+
* <p>If your bucket has versioning enabled, you could have multiple versions of the same
|
|
3345
|
+
* object. By default, <code>x-amz-copy-source</code> identifies the current version of the
|
|
3346
|
+
* source object to copy. To copy a specific version of the source object to copy, append
|
|
3347
|
+
* <code>?versionId=<version-id></code> to the <code>x-amz-copy-source</code> request
|
|
3348
|
+
* header (for example, <code>x-amz-copy-source:
|
|
3349
|
+
* /awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893</code>). </p>
|
|
3350
|
+
* <p>If the current version is a delete marker and you don't specify a versionId in the
|
|
3351
|
+
* <code>x-amz-copy-source</code> request header, Amazon S3 returns a <code>404 Not Found</code>
|
|
3352
|
+
* error, because the object does not exist. If you specify versionId in the
|
|
3353
|
+
* <code>x-amz-copy-source</code> and the versionId is a delete marker, Amazon S3 returns an
|
|
3354
|
+
* HTTP <code>400 Bad Request</code> error, because you are not allowed to specify a delete
|
|
3355
|
+
* marker as a version for the <code>x-amz-copy-source</code>. </p>
|
|
3356
|
+
* <note>
|
|
3357
|
+
* <p>
|
|
3358
|
+
* <b>Directory buckets</b> -
|
|
3359
|
+
* S3 Versioning isn't enabled and supported for directory buckets.</p>
|
|
3360
|
+
* </note>
|
|
3361
|
+
* @public
|
|
3362
|
+
*/
|
|
3363
|
+
CopySource: string | undefined;
|
|
3364
|
+
/**
|
|
3365
|
+
* <p>Copies the object if its entity tag (ETag) matches the specified tag.</p>
|
|
3366
|
+
* <p>If both of the <code>x-amz-copy-source-if-match</code> and
|
|
3367
|
+
* <code>x-amz-copy-source-if-unmodified-since</code> headers are present in the request as
|
|
3368
|
+
* follows:</p>
|
|
3369
|
+
* <p>
|
|
3370
|
+
* <code>x-amz-copy-source-if-match</code> condition evaluates to <code>true</code>,
|
|
3371
|
+
* and;</p>
|
|
3372
|
+
* <p>
|
|
3373
|
+
* <code>x-amz-copy-source-if-unmodified-since</code> condition evaluates to
|
|
3374
|
+
* <code>false</code>;</p>
|
|
3375
|
+
* <p>Amazon S3 returns <code>200 OK</code> and copies the data.
|
|
3376
|
+
* </p>
|
|
3377
|
+
* @public
|
|
3378
|
+
*/
|
|
3379
|
+
CopySourceIfMatch?: string | undefined;
|
|
3380
|
+
/**
|
|
3381
|
+
* <p>Copies the object if it has been modified since the specified time.</p>
|
|
3382
|
+
* <p>If both of the <code>x-amz-copy-source-if-none-match</code> and
|
|
3383
|
+
* <code>x-amz-copy-source-if-modified-since</code> headers are present in the request as
|
|
3384
|
+
* follows:</p>
|
|
3385
|
+
* <p>
|
|
3386
|
+
* <code>x-amz-copy-source-if-none-match</code> condition evaluates to <code>false</code>,
|
|
3387
|
+
* and;</p>
|
|
3388
|
+
* <p>
|
|
3389
|
+
* <code>x-amz-copy-source-if-modified-since</code> condition evaluates to
|
|
3390
|
+
* <code>true</code>;</p>
|
|
3391
|
+
* <p>Amazon S3 returns <code>412 Precondition Failed</code> response code.
|
|
3392
|
+
* </p>
|
|
3393
|
+
* @public
|
|
3394
|
+
*/
|
|
3395
|
+
CopySourceIfModifiedSince?: Date | undefined;
|
|
3396
|
+
/**
|
|
3397
|
+
* <p>Copies the object if its entity tag (ETag) is different than the specified ETag.</p>
|
|
3398
|
+
* <p>If both of the <code>x-amz-copy-source-if-none-match</code> and
|
|
3399
|
+
* <code>x-amz-copy-source-if-modified-since</code> headers are present in the request as
|
|
3400
|
+
* follows:</p>
|
|
3401
|
+
* <p>
|
|
3402
|
+
* <code>x-amz-copy-source-if-none-match</code> condition evaluates to <code>false</code>,
|
|
3403
|
+
* and;</p>
|
|
3404
|
+
* <p>
|
|
3405
|
+
* <code>x-amz-copy-source-if-modified-since</code> condition evaluates to
|
|
3406
|
+
* <code>true</code>;</p>
|
|
3407
|
+
* <p>Amazon S3 returns <code>412 Precondition Failed</code> response code.
|
|
3408
|
+
* </p>
|
|
3409
|
+
* @public
|
|
3410
|
+
*/
|
|
3411
|
+
CopySourceIfNoneMatch?: string | undefined;
|
|
3412
|
+
/**
|
|
3413
|
+
* <p>Copies the object if it hasn't been modified since the specified time.</p>
|
|
3414
|
+
* <p>If both of the <code>x-amz-copy-source-if-match</code> and
|
|
3415
|
+
* <code>x-amz-copy-source-if-unmodified-since</code> headers are present in the request as
|
|
3416
|
+
* follows:</p>
|
|
3417
|
+
* <p>
|
|
3418
|
+
* <code>x-amz-copy-source-if-match</code> condition evaluates to <code>true</code>,
|
|
3419
|
+
* and;</p>
|
|
3420
|
+
* <p>
|
|
3421
|
+
* <code>x-amz-copy-source-if-unmodified-since</code> condition evaluates to
|
|
3422
|
+
* <code>false</code>;</p>
|
|
3423
|
+
* <p>Amazon S3 returns <code>200 OK</code> and copies the data.
|
|
3424
|
+
* </p>
|
|
3425
|
+
* @public
|
|
3426
|
+
*/
|
|
3427
|
+
CopySourceIfUnmodifiedSince?: Date | undefined;
|
|
3428
|
+
/**
|
|
3429
|
+
* <p>The range of bytes to copy from the source object. The range value must use the form
|
|
3430
|
+
* bytes=first-last, where the first and last are the zero-based byte offsets to copy. For
|
|
3431
|
+
* example, bytes=0-9 indicates that you want to copy the first 10 bytes of the source. You
|
|
3432
|
+
* can copy a range only if the source object is greater than 5 MB.</p>
|
|
3433
|
+
* @public
|
|
3434
|
+
*/
|
|
3435
|
+
CopySourceRange?: string | undefined;
|
|
3436
|
+
/**
|
|
3437
|
+
* <p>Object key for which the multipart upload was initiated.</p>
|
|
3438
|
+
* @public
|
|
3439
|
+
*/
|
|
3440
|
+
Key: string | undefined;
|
|
3441
|
+
/**
|
|
3442
|
+
* <p>Part number of part being copied. This is a positive integer between 1 and
|
|
3443
|
+
* 10,000.</p>
|
|
3444
|
+
* @public
|
|
3445
|
+
*/
|
|
3446
|
+
PartNumber: number | undefined;
|
|
3447
|
+
/**
|
|
3448
|
+
* <p>Upload ID identifying the multipart upload whose part is being copied.</p>
|
|
3449
|
+
* @public
|
|
3450
|
+
*/
|
|
3451
|
+
UploadId: string | undefined;
|
|
3452
|
+
/**
|
|
3453
|
+
* <p>Specifies the algorithm to use when encrypting the object (for example, AES256).</p>
|
|
3454
|
+
* <note>
|
|
3455
|
+
* <p>This functionality is not supported when the destination bucket is a directory bucket.</p>
|
|
3456
|
+
* </note>
|
|
3457
|
+
* @public
|
|
3458
|
+
*/
|
|
3459
|
+
SSECustomerAlgorithm?: string | undefined;
|
|
3460
|
+
/**
|
|
3461
|
+
* <p>Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This
|
|
3462
|
+
* value is used to store the object and then it is discarded; Amazon S3 does not store the
|
|
3463
|
+
* encryption key. The key must be appropriate for use with the algorithm specified in the
|
|
3464
|
+
* <code>x-amz-server-side-encryption-customer-algorithm</code> header. This must be the
|
|
3465
|
+
* same encryption key specified in the initiate multipart upload request.</p>
|
|
3466
|
+
* <note>
|
|
3467
|
+
* <p>This functionality is not supported when the destination bucket is a directory bucket.</p>
|
|
3468
|
+
* </note>
|
|
3469
|
+
* @public
|
|
3470
|
+
*/
|
|
3471
|
+
SSECustomerKey?: string | undefined;
|
|
3472
|
+
/**
|
|
3473
|
+
* <p>Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses
|
|
3474
|
+
* this header for a message integrity check to ensure that the encryption key was transmitted
|
|
3475
|
+
* without error.</p>
|
|
3476
|
+
* <note>
|
|
3477
|
+
* <p>This functionality is not supported when the destination bucket is a directory bucket.</p>
|
|
3478
|
+
* </note>
|
|
3479
|
+
* @public
|
|
3480
|
+
*/
|
|
3481
|
+
SSECustomerKeyMD5?: string | undefined;
|
|
3482
|
+
/**
|
|
3483
|
+
* <p>Specifies the algorithm to use when decrypting the source object (for example,
|
|
3484
|
+
* <code>AES256</code>).</p>
|
|
3485
|
+
* <note>
|
|
3486
|
+
* <p>This functionality is not supported when the source object is in a directory bucket.</p>
|
|
3487
|
+
* </note>
|
|
3488
|
+
* @public
|
|
3489
|
+
*/
|
|
3490
|
+
CopySourceSSECustomerAlgorithm?: string | undefined;
|
|
3491
|
+
/**
|
|
3492
|
+
* <p>Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source
|
|
3493
|
+
* object. The encryption key provided in this header must be one that was used when the
|
|
3494
|
+
* source object was created.</p>
|
|
3495
|
+
* <note>
|
|
3496
|
+
* <p>This functionality is not supported when the source object is in a directory bucket.</p>
|
|
3497
|
+
* </note>
|
|
3498
|
+
* @public
|
|
3499
|
+
*/
|
|
3500
|
+
CopySourceSSECustomerKey?: string | undefined;
|
|
3501
|
+
/**
|
|
3502
|
+
* <p>Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses
|
|
3503
|
+
* this header for a message integrity check to ensure that the encryption key was transmitted
|
|
3504
|
+
* without error.</p>
|
|
3505
|
+
* <note>
|
|
3506
|
+
* <p>This functionality is not supported when the source object is in a directory bucket.</p>
|
|
3507
|
+
* </note>
|
|
3508
|
+
* @public
|
|
3509
|
+
*/
|
|
3510
|
+
CopySourceSSECustomerKeyMD5?: string | undefined;
|
|
3511
|
+
/**
|
|
3512
|
+
* <p>Confirms that the requester knows that they will be charged for the request. Bucket
|
|
3513
|
+
* owners need not specify this parameter in their requests. If either the source or
|
|
3514
|
+
* destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding
|
|
3515
|
+
* charges to copy the object. For information about downloading objects from Requester Pays
|
|
3516
|
+
* buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in
|
|
3517
|
+
* Requester Pays Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
3518
|
+
* <note>
|
|
3519
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
3520
|
+
* </note>
|
|
3521
|
+
* @public
|
|
3522
|
+
*/
|
|
3523
|
+
RequestPayer?: RequestPayer | undefined;
|
|
3524
|
+
/**
|
|
3525
|
+
* <p>The account ID of the expected destination bucket owner. If the account ID that you provide does not match the actual owner of the destination bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
|
|
3526
|
+
* @public
|
|
3527
|
+
*/
|
|
3528
|
+
ExpectedBucketOwner?: string | undefined;
|
|
3529
|
+
/**
|
|
3530
|
+
* <p>The account ID of the expected source bucket owner. If the account ID that you provide does not match the actual owner of the source bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
|
|
3531
|
+
* @public
|
|
3532
|
+
*/
|
|
3533
|
+
ExpectedSourceBucketOwner?: string | undefined;
|
|
3534
|
+
}
|
|
3535
|
+
/**
|
|
3536
|
+
* @public
|
|
3537
|
+
*/
|
|
3538
|
+
export interface WriteGetObjectResponseRequest {
|
|
3539
|
+
/**
|
|
3540
|
+
* <p>Route prefix to the HTTP URL generated.</p>
|
|
3541
|
+
* @public
|
|
3542
|
+
*/
|
|
3543
|
+
RequestRoute: string | undefined;
|
|
3544
|
+
/**
|
|
3545
|
+
* <p>A single use encrypted token that maps <code>WriteGetObjectResponse</code> to the end
|
|
3546
|
+
* user <code>GetObject</code> request.</p>
|
|
3547
|
+
* @public
|
|
3548
|
+
*/
|
|
3549
|
+
RequestToken: string | undefined;
|
|
3550
|
+
/**
|
|
3551
|
+
* <p>The object data.</p>
|
|
3552
|
+
* @public
|
|
3553
|
+
*/
|
|
3554
|
+
Body?: StreamingBlobTypes | undefined;
|
|
3555
|
+
/**
|
|
3556
|
+
* <p>The integer status code for an HTTP response of a corresponding <code>GetObject</code>
|
|
3557
|
+
* request. The following is a list of status codes.</p>
|
|
3558
|
+
* <ul>
|
|
3559
|
+
* <li>
|
|
3560
|
+
* <p>
|
|
3561
|
+
* <code>200 - OK</code>
|
|
3562
|
+
* </p>
|
|
3563
|
+
* </li>
|
|
3564
|
+
* <li>
|
|
3565
|
+
* <p>
|
|
3566
|
+
* <code>206 - Partial Content</code>
|
|
3567
|
+
* </p>
|
|
3568
|
+
* </li>
|
|
3569
|
+
* <li>
|
|
3570
|
+
* <p>
|
|
3571
|
+
* <code>304 - Not Modified</code>
|
|
3572
|
+
* </p>
|
|
3573
|
+
* </li>
|
|
3574
|
+
* <li>
|
|
3575
|
+
* <p>
|
|
3576
|
+
* <code>400 - Bad Request</code>
|
|
3577
|
+
* </p>
|
|
3578
|
+
* </li>
|
|
3579
|
+
* <li>
|
|
3580
|
+
* <p>
|
|
3581
|
+
* <code>401 - Unauthorized</code>
|
|
3582
|
+
* </p>
|
|
3583
|
+
* </li>
|
|
3584
|
+
* <li>
|
|
3585
|
+
* <p>
|
|
3586
|
+
* <code>403 - Forbidden</code>
|
|
3587
|
+
* </p>
|
|
3588
|
+
* </li>
|
|
3589
|
+
* <li>
|
|
3590
|
+
* <p>
|
|
3591
|
+
* <code>404 - Not Found</code>
|
|
3592
|
+
* </p>
|
|
3593
|
+
* </li>
|
|
3594
|
+
* <li>
|
|
3595
|
+
* <p>
|
|
3596
|
+
* <code>405 - Method Not Allowed</code>
|
|
3597
|
+
* </p>
|
|
3598
|
+
* </li>
|
|
3599
|
+
* <li>
|
|
3600
|
+
* <p>
|
|
3601
|
+
* <code>409 - Conflict</code>
|
|
3602
|
+
* </p>
|
|
3603
|
+
* </li>
|
|
3604
|
+
* <li>
|
|
3605
|
+
* <p>
|
|
3606
|
+
* <code>411 - Length Required</code>
|
|
3607
|
+
* </p>
|
|
3608
|
+
* </li>
|
|
3609
|
+
* <li>
|
|
3610
|
+
* <p>
|
|
3611
|
+
* <code>412 - Precondition Failed</code>
|
|
3612
|
+
* </p>
|
|
3613
|
+
* </li>
|
|
3614
|
+
* <li>
|
|
3615
|
+
* <p>
|
|
3616
|
+
* <code>416 - Range Not Satisfiable</code>
|
|
3617
|
+
* </p>
|
|
3618
|
+
* </li>
|
|
3619
|
+
* <li>
|
|
3620
|
+
* <p>
|
|
3621
|
+
* <code>500 - Internal Server Error</code>
|
|
3622
|
+
* </p>
|
|
3623
|
+
* </li>
|
|
3624
|
+
* <li>
|
|
3625
|
+
* <p>
|
|
3626
|
+
* <code>503 - Service Unavailable</code>
|
|
3627
|
+
* </p>
|
|
3628
|
+
* </li>
|
|
3629
|
+
* </ul>
|
|
3630
|
+
* @public
|
|
3631
|
+
*/
|
|
3632
|
+
StatusCode?: number | undefined;
|
|
3633
|
+
/**
|
|
3634
|
+
* <p>A string that uniquely identifies an error condition. Returned in the <Code> tag
|
|
3635
|
+
* of the error XML response for a corresponding <code>GetObject</code> call. Cannot be used
|
|
3636
|
+
* with a successful <code>StatusCode</code> header or when the transformed object is provided
|
|
3637
|
+
* in the body. All error codes from S3 are sentence-cased. The regular expression (regex)
|
|
3638
|
+
* value is <code>"^[A-Z][a-zA-Z]+$"</code>.</p>
|
|
3639
|
+
* @public
|
|
3640
|
+
*/
|
|
3641
|
+
ErrorCode?: string | undefined;
|
|
3642
|
+
/**
|
|
3643
|
+
* <p>Contains a generic description of the error condition. Returned in the <Message>
|
|
3644
|
+
* tag of the error XML response for a corresponding <code>GetObject</code> call. Cannot be
|
|
3645
|
+
* used with a successful <code>StatusCode</code> header or when the transformed object is
|
|
3646
|
+
* provided in body.</p>
|
|
3647
|
+
* @public
|
|
3648
|
+
*/
|
|
3649
|
+
ErrorMessage?: string | undefined;
|
|
3650
|
+
/**
|
|
3651
|
+
* <p>Indicates that a range of bytes was specified.</p>
|
|
3652
|
+
* @public
|
|
3653
|
+
*/
|
|
3654
|
+
AcceptRanges?: string | undefined;
|
|
3655
|
+
/**
|
|
3656
|
+
* <p>Specifies caching behavior along the request/reply chain.</p>
|
|
3657
|
+
* @public
|
|
3658
|
+
*/
|
|
3659
|
+
CacheControl?: string | undefined;
|
|
3660
|
+
/**
|
|
3661
|
+
* <p>Specifies presentational information for the object.</p>
|
|
3662
|
+
* @public
|
|
3663
|
+
*/
|
|
3664
|
+
ContentDisposition?: string | undefined;
|
|
3665
|
+
/**
|
|
3666
|
+
* <p>Specifies what content encodings have been applied to the object and thus what decoding
|
|
3667
|
+
* mechanisms must be applied to obtain the media-type referenced by the Content-Type header
|
|
3668
|
+
* field.</p>
|
|
3669
|
+
* @public
|
|
3670
|
+
*/
|
|
3671
|
+
ContentEncoding?: string | undefined;
|
|
3672
|
+
/**
|
|
3673
|
+
* <p>The language the content is in.</p>
|
|
3674
|
+
* @public
|
|
3675
|
+
*/
|
|
3676
|
+
ContentLanguage?: string | undefined;
|
|
3677
|
+
/**
|
|
3678
|
+
* <p>The size of the content body in bytes.</p>
|
|
3679
|
+
* @public
|
|
3680
|
+
*/
|
|
3681
|
+
ContentLength?: number | undefined;
|
|
3682
|
+
/**
|
|
3683
|
+
* <p>The portion of the object returned in the response.</p>
|
|
3684
|
+
* @public
|
|
3685
|
+
*/
|
|
3686
|
+
ContentRange?: string | undefined;
|
|
3687
|
+
/**
|
|
3688
|
+
* <p>A standard MIME type describing the format of the object data.</p>
|
|
3689
|
+
* @public
|
|
3690
|
+
*/
|
|
3691
|
+
ContentType?: string | undefined;
|
|
3692
|
+
/**
|
|
3693
|
+
* <p>This header can be used as a data integrity check to verify that the data received is
|
|
3694
|
+
* the same data that was originally sent. This specifies the base64-encoded, 32-bit CRC-32
|
|
3695
|
+
* checksum of the object returned by the Object Lambda function. This may not match the
|
|
3696
|
+
* checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values
|
|
3697
|
+
* only when the original <code>GetObject</code> request required checksum validation. For
|
|
3698
|
+
* more information about checksums, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object
|
|
3699
|
+
* integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
3700
|
+
* <p>Only one checksum header can be specified at a time. If you supply multiple checksum
|
|
3701
|
+
* headers, this request will fail.</p>
|
|
3702
|
+
* <p></p>
|
|
3703
|
+
* @public
|
|
3704
|
+
*/
|
|
3705
|
+
ChecksumCRC32?: string | undefined;
|
|
3706
|
+
/**
|
|
3707
|
+
* <p>This header can be used as a data integrity check to verify that the data received is
|
|
3708
|
+
* the same data that was originally sent. This specifies the base64-encoded, 32-bit CRC-32C
|
|
3709
|
+
* checksum of the object returned by the Object Lambda function. This may not match the
|
|
3710
|
+
* checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values
|
|
3711
|
+
* only when the original <code>GetObject</code> request required checksum validation. For
|
|
3712
|
+
* more information about checksums, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object
|
|
3713
|
+
* integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
3714
|
+
* <p>Only one checksum header can be specified at a time. If you supply multiple checksum
|
|
3715
|
+
* headers, this request will fail.</p>
|
|
3716
|
+
* @public
|
|
3717
|
+
*/
|
|
3718
|
+
ChecksumCRC32C?: string | undefined;
|
|
3719
|
+
/**
|
|
3720
|
+
* <p>This header can be used as a data integrity check to verify that the data received is
|
|
3721
|
+
* the same data that was originally sent. This specifies the base64-encoded, 160-bit SHA-1
|
|
3722
|
+
* digest of the object returned by the Object Lambda function. This may not match the
|
|
3723
|
+
* checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values
|
|
3724
|
+
* only when the original <code>GetObject</code> request required checksum validation. For
|
|
3725
|
+
* more information about checksums, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object
|
|
3726
|
+
* integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
3727
|
+
* <p>Only one checksum header can be specified at a time. If you supply multiple checksum
|
|
3728
|
+
* headers, this request will fail.</p>
|
|
3729
|
+
* @public
|
|
3730
|
+
*/
|
|
3731
|
+
ChecksumSHA1?: string | undefined;
|
|
3732
|
+
/**
|
|
3733
|
+
* <p>This header can be used as a data integrity check to verify that the data received is
|
|
3734
|
+
* the same data that was originally sent. This specifies the base64-encoded, 256-bit SHA-256
|
|
3735
|
+
* digest of the object returned by the Object Lambda function. This may not match the
|
|
3736
|
+
* checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values
|
|
3737
|
+
* only when the original <code>GetObject</code> request required checksum validation. For
|
|
3738
|
+
* more information about checksums, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object
|
|
3739
|
+
* integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
3740
|
+
* <p>Only one checksum header can be specified at a time. If you supply multiple checksum
|
|
3741
|
+
* headers, this request will fail.</p>
|
|
3742
|
+
* @public
|
|
3743
|
+
*/
|
|
3744
|
+
ChecksumSHA256?: string | undefined;
|
|
3745
|
+
/**
|
|
3746
|
+
* <p>Specifies whether an object stored in Amazon S3 is (<code>true</code>) or is not
|
|
3747
|
+
* (<code>false</code>) a delete marker. </p>
|
|
3748
|
+
* @public
|
|
3749
|
+
*/
|
|
3750
|
+
DeleteMarker?: boolean | undefined;
|
|
3751
|
+
/**
|
|
3752
|
+
* <p>An opaque identifier assigned by a web server to a specific version of a resource found
|
|
3753
|
+
* at a URL. </p>
|
|
3754
|
+
* @public
|
|
3755
|
+
*/
|
|
3756
|
+
ETag?: string | undefined;
|
|
3757
|
+
/**
|
|
3758
|
+
* <p>The date and time at which the object is no longer cacheable.</p>
|
|
3759
|
+
* @public
|
|
3760
|
+
*/
|
|
3761
|
+
Expires?: Date | undefined;
|
|
3762
|
+
/**
|
|
3763
|
+
* <p>If the object expiration is configured (see PUT Bucket lifecycle), the response includes
|
|
3764
|
+
* this header. It includes the <code>expiry-date</code> and <code>rule-id</code> key-value
|
|
3765
|
+
* pairs that provide the object expiration information. The value of the <code>rule-id</code>
|
|
3766
|
+
* is URL-encoded. </p>
|
|
3767
|
+
* @public
|
|
3768
|
+
*/
|
|
3769
|
+
Expiration?: string | undefined;
|
|
3770
|
+
/**
|
|
3771
|
+
* <p>The date and time that the object was last modified.</p>
|
|
3772
|
+
* @public
|
|
3773
|
+
*/
|
|
3774
|
+
LastModified?: Date | undefined;
|
|
3775
|
+
/**
|
|
3776
|
+
* <p>Set to the number of metadata entries not returned in <code>x-amz-meta</code> headers.
|
|
3777
|
+
* This can happen if you create metadata using an API like SOAP that supports more flexible
|
|
3778
|
+
* metadata than the REST API. For example, using SOAP, you can create metadata whose values
|
|
3779
|
+
* are not legal HTTP headers.</p>
|
|
3780
|
+
* @public
|
|
3781
|
+
*/
|
|
3782
|
+
MissingMeta?: number | undefined;
|
|
3783
|
+
/**
|
|
3784
|
+
* <p>A map of metadata to store with the object in S3.</p>
|
|
3785
|
+
* @public
|
|
3786
|
+
*/
|
|
3787
|
+
Metadata?: Record<string, string> | undefined;
|
|
3788
|
+
/**
|
|
3789
|
+
* <p>Indicates whether an object stored in Amazon S3 has Object Lock enabled. For more information
|
|
3790
|
+
* about S3 Object Lock, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock.html">Object Lock</a>.</p>
|
|
3791
|
+
* @public
|
|
3792
|
+
*/
|
|
3793
|
+
ObjectLockMode?: ObjectLockMode | undefined;
|
|
3794
|
+
/**
|
|
3795
|
+
* <p>Indicates whether an object stored in Amazon S3 has an active legal hold.</p>
|
|
3796
|
+
* @public
|
|
3797
|
+
*/
|
|
3798
|
+
ObjectLockLegalHoldStatus?: ObjectLockLegalHoldStatus | undefined;
|
|
3799
|
+
/**
|
|
3800
|
+
* <p>The date and time when Object Lock is configured to expire.</p>
|
|
3801
|
+
* @public
|
|
3802
|
+
*/
|
|
3803
|
+
ObjectLockRetainUntilDate?: Date | undefined;
|
|
3804
|
+
/**
|
|
3805
|
+
* <p>The count of parts this object has.</p>
|
|
3806
|
+
* @public
|
|
3807
|
+
*/
|
|
3808
|
+
PartsCount?: number | undefined;
|
|
3809
|
+
/**
|
|
3810
|
+
* <p>Indicates if request involves bucket that is either a source or destination in a
|
|
3811
|
+
* Replication rule. For more information about S3 Replication, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/replication.html">Replication</a>.</p>
|
|
3812
|
+
* @public
|
|
3813
|
+
*/
|
|
3814
|
+
ReplicationStatus?: ReplicationStatus | undefined;
|
|
3815
|
+
/**
|
|
3816
|
+
* <p>If present, indicates that the requester was successfully charged for the
|
|
3817
|
+
* request.</p>
|
|
3818
|
+
* <note>
|
|
3819
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
3820
|
+
* </note>
|
|
3821
|
+
* @public
|
|
3822
|
+
*/
|
|
3823
|
+
RequestCharged?: RequestCharged | undefined;
|
|
3824
|
+
/**
|
|
3825
|
+
* <p>Provides information about object restoration operation and expiration time of the
|
|
3826
|
+
* restored object copy.</p>
|
|
3827
|
+
* @public
|
|
3828
|
+
*/
|
|
3829
|
+
Restore?: string | undefined;
|
|
3830
|
+
/**
|
|
3831
|
+
* <p> The server-side encryption algorithm used when storing requested object in Amazon S3 (for
|
|
3832
|
+
* example, AES256, <code>aws:kms</code>).</p>
|
|
3833
|
+
* @public
|
|
3834
|
+
*/
|
|
3835
|
+
ServerSideEncryption?: ServerSideEncryption | undefined;
|
|
3836
|
+
/**
|
|
3837
|
+
* <p>Encryption algorithm used if server-side encryption with a customer-provided encryption
|
|
3838
|
+
* key was specified for object stored in Amazon S3.</p>
|
|
3839
|
+
* @public
|
|
3840
|
+
*/
|
|
3841
|
+
SSECustomerAlgorithm?: string | undefined;
|
|
3842
|
+
/**
|
|
3843
|
+
* <p> If present, specifies the ID (Key ID, Key ARN, or Key Alias) of the Amazon Web Services Key
|
|
3844
|
+
* Management Service (Amazon Web Services KMS) symmetric encryption customer managed key that was used for stored in
|
|
3845
|
+
* Amazon S3 object. </p>
|
|
3846
|
+
* @public
|
|
3847
|
+
*/
|
|
3848
|
+
SSEKMSKeyId?: string | undefined;
|
|
3849
|
+
/**
|
|
3850
|
+
* <p> 128-bit MD5 digest of customer-provided encryption key used in Amazon S3 to encrypt data
|
|
3851
|
+
* stored in S3. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerSideEncryptionCustomerKeys.html">Protecting data
|
|
3852
|
+
* using server-side encryption with customer-provided encryption keys
|
|
3853
|
+
* (SSE-C)</a>.</p>
|
|
3854
|
+
* @public
|
|
3855
|
+
*/
|
|
3856
|
+
SSECustomerKeyMD5?: string | undefined;
|
|
3857
|
+
/**
|
|
3858
|
+
* <p>Provides storage class information of the object. Amazon S3 returns this header for all
|
|
3859
|
+
* objects except for S3 Standard storage class objects.</p>
|
|
3860
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html">Storage Classes</a>.</p>
|
|
3861
|
+
* @public
|
|
3862
|
+
*/
|
|
3863
|
+
StorageClass?: StorageClass | undefined;
|
|
3864
|
+
/**
|
|
3865
|
+
* <p>The number of tags, if any, on the object.</p>
|
|
3866
|
+
* @public
|
|
3867
|
+
*/
|
|
3868
|
+
TagCount?: number | undefined;
|
|
3869
|
+
/**
|
|
3870
|
+
* <p>An ID used to reference a specific version of the object.</p>
|
|
3871
|
+
* @public
|
|
3872
|
+
*/
|
|
3873
|
+
VersionId?: string | undefined;
|
|
3874
|
+
/**
|
|
3875
|
+
* <p> Indicates whether the object stored in Amazon S3 uses an S3 bucket key for server-side
|
|
3876
|
+
* encryption with Amazon Web Services KMS (SSE-KMS).</p>
|
|
3877
|
+
* @public
|
|
3878
|
+
*/
|
|
3879
|
+
BucketKeyEnabled?: boolean | undefined;
|
|
3880
|
+
}
|
|
3881
|
+
/**
|
|
3882
|
+
* @internal
|
|
3883
|
+
*/
|
|
3884
|
+
export declare const PutBucketEncryptionRequestFilterSensitiveLog: (obj: PutBucketEncryptionRequest) => any;
|
|
3885
|
+
/**
|
|
3886
|
+
* @internal
|
|
3887
|
+
*/
|
|
3888
|
+
export declare const PutBucketInventoryConfigurationRequestFilterSensitiveLog: (obj: PutBucketInventoryConfigurationRequest) => any;
|
|
3889
|
+
/**
|
|
3890
|
+
* @internal
|
|
3891
|
+
*/
|
|
3892
|
+
export declare const PutObjectOutputFilterSensitiveLog: (obj: PutObjectOutput) => any;
|
|
3893
|
+
/**
|
|
3894
|
+
* @internal
|
|
3895
|
+
*/
|
|
3896
|
+
export declare const PutObjectRequestFilterSensitiveLog: (obj: PutObjectRequest) => any;
|
|
3897
|
+
/**
|
|
3898
|
+
* @internal
|
|
3899
|
+
*/
|
|
3900
|
+
export declare const EncryptionFilterSensitiveLog: (obj: Encryption) => any;
|
|
3901
|
+
/**
|
|
3902
|
+
* @internal
|
|
3903
|
+
*/
|
|
3904
|
+
export declare const S3LocationFilterSensitiveLog: (obj: S3Location) => any;
|
|
3905
|
+
/**
|
|
3906
|
+
* @internal
|
|
3907
|
+
*/
|
|
3908
|
+
export declare const OutputLocationFilterSensitiveLog: (obj: OutputLocation) => any;
|
|
3909
|
+
/**
|
|
3910
|
+
* @internal
|
|
3911
|
+
*/
|
|
3912
|
+
export declare const RestoreRequestFilterSensitiveLog: (obj: RestoreRequest) => any;
|
|
3913
|
+
/**
|
|
3914
|
+
* @internal
|
|
3915
|
+
*/
|
|
3916
|
+
export declare const RestoreObjectRequestFilterSensitiveLog: (obj: RestoreObjectRequest) => any;
|
|
3917
|
+
/**
|
|
3918
|
+
* @internal
|
|
3919
|
+
*/
|
|
3920
|
+
export declare const SelectObjectContentEventStreamFilterSensitiveLog: (obj: SelectObjectContentEventStream) => any;
|
|
3921
|
+
/**
|
|
3922
|
+
* @internal
|
|
3923
|
+
*/
|
|
3924
|
+
export declare const SelectObjectContentOutputFilterSensitiveLog: (obj: SelectObjectContentOutput) => any;
|
|
3925
|
+
/**
|
|
3926
|
+
* @internal
|
|
3927
|
+
*/
|
|
3928
|
+
export declare const SelectObjectContentRequestFilterSensitiveLog: (obj: SelectObjectContentRequest) => any;
|
|
3929
|
+
/**
|
|
3930
|
+
* @internal
|
|
3931
|
+
*/
|
|
3932
|
+
export declare const UploadPartOutputFilterSensitiveLog: (obj: UploadPartOutput) => any;
|
|
3933
|
+
/**
|
|
3934
|
+
* @internal
|
|
3935
|
+
*/
|
|
3936
|
+
export declare const UploadPartRequestFilterSensitiveLog: (obj: UploadPartRequest) => any;
|
|
3937
|
+
/**
|
|
3938
|
+
* @internal
|
|
3939
|
+
*/
|
|
3940
|
+
export declare const UploadPartCopyOutputFilterSensitiveLog: (obj: UploadPartCopyOutput) => any;
|
|
3941
|
+
/**
|
|
3942
|
+
* @internal
|
|
3943
|
+
*/
|
|
3944
|
+
export declare const UploadPartCopyRequestFilterSensitiveLog: (obj: UploadPartCopyRequest) => any;
|
|
3945
|
+
/**
|
|
3946
|
+
* @internal
|
|
3947
|
+
*/
|
|
3948
|
+
export declare const WriteGetObjectResponseRequestFilterSensitiveLog: (obj: WriteGetObjectResponseRequest) => any;
|