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