@aws-sdk/client-s3 3.458.0 → 3.461.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +16 -0
- package/dist-cjs/S3.js +4 -0
- package/dist-cjs/S3Client.js +3 -1
- package/dist-cjs/commands/AbortMultipartUploadCommand.js +1 -0
- package/dist-cjs/commands/CompleteMultipartUploadCommand.js +1 -0
- package/dist-cjs/commands/CopyObjectCommand.js +1 -0
- package/dist-cjs/commands/CreateBucketCommand.js +2 -0
- package/dist-cjs/commands/CreateMultipartUploadCommand.js +1 -0
- package/dist-cjs/commands/CreateSessionCommand.js +59 -0
- package/dist-cjs/commands/DeleteBucketAnalyticsConfigurationCommand.js +2 -0
- package/dist-cjs/commands/DeleteBucketCommand.js +2 -0
- package/dist-cjs/commands/DeleteBucketCorsCommand.js +2 -0
- package/dist-cjs/commands/DeleteBucketEncryptionCommand.js +2 -0
- package/dist-cjs/commands/DeleteBucketIntelligentTieringConfigurationCommand.js +2 -0
- package/dist-cjs/commands/DeleteBucketInventoryConfigurationCommand.js +2 -0
- package/dist-cjs/commands/DeleteBucketLifecycleCommand.js +2 -0
- package/dist-cjs/commands/DeleteBucketMetricsConfigurationCommand.js +2 -0
- package/dist-cjs/commands/DeleteBucketOwnershipControlsCommand.js +2 -0
- package/dist-cjs/commands/DeleteBucketPolicyCommand.js +2 -0
- package/dist-cjs/commands/DeleteBucketReplicationCommand.js +2 -0
- package/dist-cjs/commands/DeleteBucketTaggingCommand.js +2 -0
- package/dist-cjs/commands/DeleteBucketWebsiteCommand.js +2 -0
- package/dist-cjs/commands/DeleteObjectCommand.js +1 -0
- package/dist-cjs/commands/DeleteObjectTaggingCommand.js +1 -0
- package/dist-cjs/commands/DeleteObjectsCommand.js +1 -0
- package/dist-cjs/commands/DeletePublicAccessBlockCommand.js +2 -0
- package/dist-cjs/commands/GetBucketAccelerateConfigurationCommand.js +2 -0
- package/dist-cjs/commands/GetBucketAclCommand.js +2 -0
- package/dist-cjs/commands/GetBucketAnalyticsConfigurationCommand.js +2 -0
- package/dist-cjs/commands/GetBucketCorsCommand.js +2 -0
- package/dist-cjs/commands/GetBucketEncryptionCommand.js +2 -0
- package/dist-cjs/commands/GetBucketIntelligentTieringConfigurationCommand.js +2 -0
- package/dist-cjs/commands/GetBucketInventoryConfigurationCommand.js +2 -0
- package/dist-cjs/commands/GetBucketLifecycleConfigurationCommand.js +2 -0
- package/dist-cjs/commands/GetBucketLocationCommand.js +2 -0
- package/dist-cjs/commands/GetBucketLoggingCommand.js +2 -0
- package/dist-cjs/commands/GetBucketMetricsConfigurationCommand.js +2 -0
- package/dist-cjs/commands/GetBucketNotificationConfigurationCommand.js +2 -0
- package/dist-cjs/commands/GetBucketOwnershipControlsCommand.js +2 -0
- package/dist-cjs/commands/GetBucketPolicyCommand.js +2 -0
- package/dist-cjs/commands/GetBucketPolicyStatusCommand.js +2 -0
- package/dist-cjs/commands/GetBucketReplicationCommand.js +2 -0
- package/dist-cjs/commands/GetBucketRequestPaymentCommand.js +2 -0
- package/dist-cjs/commands/GetBucketTaggingCommand.js +2 -0
- package/dist-cjs/commands/GetBucketVersioningCommand.js +2 -0
- package/dist-cjs/commands/GetBucketWebsiteCommand.js +2 -0
- package/dist-cjs/commands/GetObjectAclCommand.js +1 -0
- package/dist-cjs/commands/GetObjectAttributesCommand.js +1 -0
- package/dist-cjs/commands/GetObjectCommand.js +1 -0
- package/dist-cjs/commands/GetObjectLegalHoldCommand.js +1 -0
- package/dist-cjs/commands/GetObjectLockConfigurationCommand.js +1 -0
- package/dist-cjs/commands/GetObjectRetentionCommand.js +1 -0
- package/dist-cjs/commands/GetObjectTaggingCommand.js +1 -0
- package/dist-cjs/commands/GetObjectTorrentCommand.js +1 -0
- package/dist-cjs/commands/GetPublicAccessBlockCommand.js +2 -0
- package/dist-cjs/commands/HeadBucketCommand.js +1 -0
- package/dist-cjs/commands/HeadObjectCommand.js +1 -0
- package/dist-cjs/commands/ListBucketAnalyticsConfigurationsCommand.js +2 -0
- package/dist-cjs/commands/ListBucketIntelligentTieringConfigurationsCommand.js +2 -0
- package/dist-cjs/commands/ListBucketInventoryConfigurationsCommand.js +2 -0
- package/dist-cjs/commands/ListBucketMetricsConfigurationsCommand.js +1 -0
- package/dist-cjs/commands/ListBucketsCommand.js +1 -0
- package/dist-cjs/commands/ListDirectoryBucketsCommand.js +58 -0
- package/dist-cjs/commands/ListMultipartUploadsCommand.js +1 -0
- package/dist-cjs/commands/ListObjectVersionsCommand.js +1 -0
- package/dist-cjs/commands/ListObjectsCommand.js +1 -0
- package/dist-cjs/commands/ListObjectsV2Command.js +1 -0
- package/dist-cjs/commands/ListPartsCommand.js +1 -0
- package/dist-cjs/commands/PutBucketAccelerateConfigurationCommand.js +2 -0
- package/dist-cjs/commands/PutBucketAclCommand.js +2 -0
- package/dist-cjs/commands/PutBucketAnalyticsConfigurationCommand.js +2 -0
- package/dist-cjs/commands/PutBucketCorsCommand.js +2 -0
- package/dist-cjs/commands/PutBucketEncryptionCommand.js +2 -0
- package/dist-cjs/commands/PutBucketIntelligentTieringConfigurationCommand.js +2 -0
- package/dist-cjs/commands/PutBucketInventoryConfigurationCommand.js +2 -0
- package/dist-cjs/commands/PutBucketLifecycleConfigurationCommand.js +2 -0
- package/dist-cjs/commands/PutBucketLoggingCommand.js +2 -0
- package/dist-cjs/commands/PutBucketMetricsConfigurationCommand.js +2 -0
- package/dist-cjs/commands/PutBucketNotificationConfigurationCommand.js +2 -0
- package/dist-cjs/commands/PutBucketOwnershipControlsCommand.js +2 -0
- package/dist-cjs/commands/PutBucketPolicyCommand.js +2 -0
- package/dist-cjs/commands/PutBucketReplicationCommand.js +2 -0
- package/dist-cjs/commands/PutBucketRequestPaymentCommand.js +2 -0
- package/dist-cjs/commands/PutBucketTaggingCommand.js +2 -0
- package/dist-cjs/commands/PutBucketVersioningCommand.js +2 -0
- package/dist-cjs/commands/PutBucketWebsiteCommand.js +2 -0
- package/dist-cjs/commands/PutObjectAclCommand.js +1 -0
- package/dist-cjs/commands/PutObjectCommand.js +4 -3
- package/dist-cjs/commands/PutObjectLegalHoldCommand.js +1 -0
- package/dist-cjs/commands/PutObjectLockConfigurationCommand.js +1 -0
- package/dist-cjs/commands/PutObjectRetentionCommand.js +1 -0
- package/dist-cjs/commands/PutObjectTaggingCommand.js +1 -0
- package/dist-cjs/commands/PutPublicAccessBlockCommand.js +2 -0
- package/dist-cjs/commands/RestoreObjectCommand.js +1 -0
- package/dist-cjs/commands/SelectObjectContentCommand.js +1 -0
- package/dist-cjs/commands/UploadPartCommand.js +1 -0
- package/dist-cjs/commands/UploadPartCopyCommand.js +1 -0
- package/dist-cjs/commands/WriteGetObjectResponseCommand.js +1 -0
- package/dist-cjs/commands/index.js +2 -0
- package/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-cjs/models/models_0.js +41 -32
- package/dist-cjs/models/models_1.js +18 -1
- package/dist-cjs/pagination/ListDirectoryBucketsPaginator.js +29 -0
- package/dist-cjs/pagination/index.js +1 -0
- package/dist-cjs/protocols/Aws_restXml.js +174 -4
- package/dist-cjs/runtimeConfig.js +2 -0
- package/dist-es/S3.js +4 -0
- package/dist-es/S3Client.js +4 -2
- package/dist-es/commands/AbortMultipartUploadCommand.js +1 -0
- package/dist-es/commands/CompleteMultipartUploadCommand.js +1 -0
- package/dist-es/commands/CopyObjectCommand.js +1 -0
- package/dist-es/commands/CreateBucketCommand.js +2 -0
- package/dist-es/commands/CreateMultipartUploadCommand.js +1 -0
- package/dist-es/commands/CreateSessionCommand.js +55 -0
- package/dist-es/commands/DeleteBucketAnalyticsConfigurationCommand.js +2 -0
- package/dist-es/commands/DeleteBucketCommand.js +2 -0
- package/dist-es/commands/DeleteBucketCorsCommand.js +2 -0
- package/dist-es/commands/DeleteBucketEncryptionCommand.js +2 -0
- package/dist-es/commands/DeleteBucketIntelligentTieringConfigurationCommand.js +2 -0
- package/dist-es/commands/DeleteBucketInventoryConfigurationCommand.js +2 -0
- package/dist-es/commands/DeleteBucketLifecycleCommand.js +2 -0
- package/dist-es/commands/DeleteBucketMetricsConfigurationCommand.js +2 -0
- package/dist-es/commands/DeleteBucketOwnershipControlsCommand.js +2 -0
- package/dist-es/commands/DeleteBucketPolicyCommand.js +2 -0
- package/dist-es/commands/DeleteBucketReplicationCommand.js +2 -0
- package/dist-es/commands/DeleteBucketTaggingCommand.js +2 -0
- package/dist-es/commands/DeleteBucketWebsiteCommand.js +2 -0
- package/dist-es/commands/DeleteObjectCommand.js +1 -0
- package/dist-es/commands/DeleteObjectTaggingCommand.js +1 -0
- package/dist-es/commands/DeleteObjectsCommand.js +1 -0
- package/dist-es/commands/DeletePublicAccessBlockCommand.js +2 -0
- package/dist-es/commands/GetBucketAccelerateConfigurationCommand.js +2 -0
- package/dist-es/commands/GetBucketAclCommand.js +2 -0
- package/dist-es/commands/GetBucketAnalyticsConfigurationCommand.js +2 -0
- package/dist-es/commands/GetBucketCorsCommand.js +2 -0
- package/dist-es/commands/GetBucketEncryptionCommand.js +2 -0
- package/dist-es/commands/GetBucketIntelligentTieringConfigurationCommand.js +2 -0
- package/dist-es/commands/GetBucketInventoryConfigurationCommand.js +2 -0
- package/dist-es/commands/GetBucketLifecycleConfigurationCommand.js +2 -0
- package/dist-es/commands/GetBucketLocationCommand.js +2 -0
- package/dist-es/commands/GetBucketLoggingCommand.js +2 -0
- package/dist-es/commands/GetBucketMetricsConfigurationCommand.js +2 -0
- package/dist-es/commands/GetBucketNotificationConfigurationCommand.js +2 -0
- package/dist-es/commands/GetBucketOwnershipControlsCommand.js +2 -0
- package/dist-es/commands/GetBucketPolicyCommand.js +2 -0
- package/dist-es/commands/GetBucketPolicyStatusCommand.js +2 -0
- package/dist-es/commands/GetBucketReplicationCommand.js +2 -0
- package/dist-es/commands/GetBucketRequestPaymentCommand.js +2 -0
- package/dist-es/commands/GetBucketTaggingCommand.js +2 -0
- package/dist-es/commands/GetBucketVersioningCommand.js +2 -0
- package/dist-es/commands/GetBucketWebsiteCommand.js +2 -0
- package/dist-es/commands/GetObjectAclCommand.js +1 -0
- package/dist-es/commands/GetObjectAttributesCommand.js +1 -0
- package/dist-es/commands/GetObjectCommand.js +1 -0
- package/dist-es/commands/GetObjectLegalHoldCommand.js +1 -0
- package/dist-es/commands/GetObjectLockConfigurationCommand.js +1 -0
- package/dist-es/commands/GetObjectRetentionCommand.js +1 -0
- package/dist-es/commands/GetObjectTaggingCommand.js +1 -0
- package/dist-es/commands/GetObjectTorrentCommand.js +1 -0
- package/dist-es/commands/GetPublicAccessBlockCommand.js +2 -0
- package/dist-es/commands/HeadBucketCommand.js +1 -0
- package/dist-es/commands/HeadObjectCommand.js +1 -0
- package/dist-es/commands/ListBucketAnalyticsConfigurationsCommand.js +2 -0
- package/dist-es/commands/ListBucketIntelligentTieringConfigurationsCommand.js +2 -0
- package/dist-es/commands/ListBucketInventoryConfigurationsCommand.js +2 -0
- package/dist-es/commands/ListBucketMetricsConfigurationsCommand.js +1 -0
- package/dist-es/commands/ListBucketsCommand.js +1 -0
- package/dist-es/commands/ListDirectoryBucketsCommand.js +54 -0
- package/dist-es/commands/ListMultipartUploadsCommand.js +1 -0
- package/dist-es/commands/ListObjectVersionsCommand.js +1 -0
- package/dist-es/commands/ListObjectsCommand.js +1 -0
- package/dist-es/commands/ListObjectsV2Command.js +1 -0
- package/dist-es/commands/ListPartsCommand.js +1 -0
- package/dist-es/commands/PutBucketAccelerateConfigurationCommand.js +2 -0
- package/dist-es/commands/PutBucketAclCommand.js +2 -0
- package/dist-es/commands/PutBucketAnalyticsConfigurationCommand.js +2 -0
- package/dist-es/commands/PutBucketCorsCommand.js +2 -0
- package/dist-es/commands/PutBucketEncryptionCommand.js +2 -0
- package/dist-es/commands/PutBucketIntelligentTieringConfigurationCommand.js +2 -0
- package/dist-es/commands/PutBucketInventoryConfigurationCommand.js +2 -0
- package/dist-es/commands/PutBucketLifecycleConfigurationCommand.js +2 -0
- package/dist-es/commands/PutBucketLoggingCommand.js +2 -0
- package/dist-es/commands/PutBucketMetricsConfigurationCommand.js +2 -0
- package/dist-es/commands/PutBucketNotificationConfigurationCommand.js +2 -0
- package/dist-es/commands/PutBucketOwnershipControlsCommand.js +2 -0
- package/dist-es/commands/PutBucketPolicyCommand.js +2 -0
- package/dist-es/commands/PutBucketReplicationCommand.js +2 -0
- package/dist-es/commands/PutBucketRequestPaymentCommand.js +2 -0
- package/dist-es/commands/PutBucketTaggingCommand.js +2 -0
- package/dist-es/commands/PutBucketVersioningCommand.js +2 -0
- package/dist-es/commands/PutBucketWebsiteCommand.js +2 -0
- package/dist-es/commands/PutObjectAclCommand.js +1 -0
- package/dist-es/commands/PutObjectCommand.js +2 -1
- package/dist-es/commands/PutObjectLegalHoldCommand.js +1 -0
- package/dist-es/commands/PutObjectLockConfigurationCommand.js +1 -0
- package/dist-es/commands/PutObjectRetentionCommand.js +1 -0
- package/dist-es/commands/PutObjectTaggingCommand.js +1 -0
- package/dist-es/commands/PutPublicAccessBlockCommand.js +2 -0
- package/dist-es/commands/RestoreObjectCommand.js +1 -0
- package/dist-es/commands/SelectObjectContentCommand.js +1 -0
- package/dist-es/commands/UploadPartCommand.js +1 -0
- package/dist-es/commands/UploadPartCopyCommand.js +1 -0
- package/dist-es/commands/WriteGetObjectResponseCommand.js +1 -0
- package/dist-es/commands/index.js +2 -0
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-es/models/models_0.js +36 -27
- package/dist-es/models/models_1.js +15 -0
- package/dist-es/pagination/ListDirectoryBucketsPaginator.js +25 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/protocols/Aws_restXml.js +166 -0
- package/dist-es/runtimeConfig.js +2 -0
- package/dist-types/S3.d.ts +14 -0
- package/dist-types/S3Client.d.ts +4 -2
- package/dist-types/commands/AbortMultipartUploadCommand.d.ts +37 -5
- package/dist-types/commands/CompleteMultipartUploadCommand.d.ts +97 -61
- package/dist-types/commands/CopyObjectCommand.d.ts +108 -180
- package/dist-types/commands/CreateBucketCommand.d.ts +116 -95
- package/dist-types/commands/CreateMultipartUploadCommand.d.ts +146 -224
- package/dist-types/commands/CreateSessionCommand.d.ts +145 -0
- package/dist-types/commands/DeleteBucketAnalyticsConfigurationCommand.d.ts +4 -1
- package/dist-types/commands/DeleteBucketCommand.d.ts +35 -0
- package/dist-types/commands/DeleteBucketCorsCommand.d.ts +4 -1
- package/dist-types/commands/DeleteBucketEncryptionCommand.d.ts +4 -1
- package/dist-types/commands/DeleteBucketIntelligentTieringConfigurationCommand.d.ts +4 -1
- package/dist-types/commands/DeleteBucketInventoryConfigurationCommand.d.ts +4 -1
- package/dist-types/commands/DeleteBucketLifecycleCommand.d.ts +4 -1
- package/dist-types/commands/DeleteBucketMetricsConfigurationCommand.d.ts +4 -1
- package/dist-types/commands/DeleteBucketOwnershipControlsCommand.d.ts +4 -1
- package/dist-types/commands/DeleteBucketPolicyCommand.d.ts +48 -20
- package/dist-types/commands/DeleteBucketReplicationCommand.d.ts +4 -1
- package/dist-types/commands/DeleteBucketTaggingCommand.d.ts +4 -1
- package/dist-types/commands/DeleteBucketWebsiteCommand.d.ts +4 -1
- package/dist-types/commands/DeleteObjectCommand.d.ts +83 -11
- package/dist-types/commands/DeleteObjectTaggingCommand.d.ts +15 -12
- package/dist-types/commands/DeleteObjectsCommand.d.ts +109 -35
- package/dist-types/commands/DeletePublicAccessBlockCommand.d.ts +4 -1
- package/dist-types/commands/GetBucketAccelerateConfigurationCommand.d.ts +4 -1
- package/dist-types/commands/GetBucketAclCommand.d.ts +7 -4
- package/dist-types/commands/GetBucketAnalyticsConfigurationCommand.d.ts +4 -1
- package/dist-types/commands/GetBucketCorsCommand.d.ts +6 -3
- package/dist-types/commands/GetBucketEncryptionCommand.d.ts +4 -1
- package/dist-types/commands/GetBucketIntelligentTieringConfigurationCommand.d.ts +4 -1
- package/dist-types/commands/GetBucketInventoryConfigurationCommand.d.ts +4 -1
- package/dist-types/commands/GetBucketLifecycleConfigurationCommand.d.ts +3 -0
- package/dist-types/commands/GetBucketLocationCommand.d.ts +7 -4
- package/dist-types/commands/GetBucketLoggingCommand.d.ts +4 -1
- package/dist-types/commands/GetBucketMetricsConfigurationCommand.d.ts +4 -1
- package/dist-types/commands/GetBucketNotificationConfigurationCommand.d.ts +6 -3
- package/dist-types/commands/GetBucketOwnershipControlsCommand.d.ts +4 -1
- package/dist-types/commands/GetBucketPolicyCommand.d.ts +54 -24
- package/dist-types/commands/GetBucketPolicyStatusCommand.d.ts +4 -1
- package/dist-types/commands/GetBucketReplicationCommand.d.ts +5 -2
- package/dist-types/commands/GetBucketRequestPaymentCommand.d.ts +4 -1
- package/dist-types/commands/GetBucketTaggingCommand.d.ts +4 -1
- package/dist-types/commands/GetBucketVersioningCommand.d.ts +4 -1
- package/dist-types/commands/GetBucketWebsiteCommand.d.ts +4 -1
- package/dist-types/commands/GetObjectAclCommand.d.ts +5 -2
- package/dist-types/commands/GetObjectAttributesCommand.d.ts +113 -76
- package/dist-types/commands/GetObjectCommand.d.ts +122 -140
- package/dist-types/commands/GetObjectLegalHoldCommand.d.ts +5 -2
- package/dist-types/commands/GetObjectLockConfigurationCommand.d.ts +4 -1
- package/dist-types/commands/GetObjectRetentionCommand.d.ts +5 -2
- package/dist-types/commands/GetObjectTaggingCommand.d.ts +23 -20
- package/dist-types/commands/GetObjectTorrentCommand.d.ts +5 -2
- package/dist-types/commands/GetPublicAccessBlockCommand.d.ts +4 -1
- package/dist-types/commands/HeadBucketCommand.d.ts +53 -19
- package/dist-types/commands/HeadObjectCommand.d.ts +87 -83
- package/dist-types/commands/ListBucketAnalyticsConfigurationsCommand.d.ts +4 -1
- package/dist-types/commands/ListBucketIntelligentTieringConfigurationsCommand.d.ts +4 -1
- package/dist-types/commands/ListBucketInventoryConfigurationsCommand.d.ts +4 -1
- package/dist-types/commands/ListBucketMetricsConfigurationsCommand.d.ts +4 -1
- package/dist-types/commands/ListBucketsCommand.d.ts +4 -1
- package/dist-types/commands/ListDirectoryBucketsCommand.d.ts +98 -0
- package/dist-types/commands/ListMultipartUploadsCommand.d.ts +85 -17
- package/dist-types/commands/ListObjectVersionsCommand.d.ts +4 -1
- package/dist-types/commands/ListObjectsCommand.d.ts +5 -2
- package/dist-types/commands/ListObjectsV2Command.d.ts +52 -10
- package/dist-types/commands/ListPartsCommand.d.ts +47 -14
- package/dist-types/commands/PutBucketAccelerateConfigurationCommand.d.ts +4 -1
- package/dist-types/commands/PutBucketAclCommand.d.ts +5 -2
- package/dist-types/commands/PutBucketAnalyticsConfigurationCommand.d.ts +4 -1
- package/dist-types/commands/PutBucketCorsCommand.d.ts +4 -1
- package/dist-types/commands/PutBucketEncryptionCommand.d.ts +4 -1
- package/dist-types/commands/PutBucketIntelligentTieringConfigurationCommand.d.ts +4 -1
- package/dist-types/commands/PutBucketInventoryConfigurationCommand.d.ts +4 -1
- package/dist-types/commands/PutBucketLifecycleConfigurationCommand.d.ts +4 -1
- package/dist-types/commands/PutBucketLoggingCommand.d.ts +4 -1
- package/dist-types/commands/PutBucketMetricsConfigurationCommand.d.ts +4 -1
- package/dist-types/commands/PutBucketNotificationConfigurationCommand.d.ts +4 -1
- package/dist-types/commands/PutBucketOwnershipControlsCommand.d.ts +4 -1
- package/dist-types/commands/PutBucketPolicyCommand.d.ts +54 -19
- package/dist-types/commands/PutBucketReplicationCommand.d.ts +6 -3
- package/dist-types/commands/PutBucketRequestPaymentCommand.d.ts +5 -2
- package/dist-types/commands/PutBucketTaggingCommand.d.ts +5 -2
- package/dist-types/commands/PutBucketVersioningCommand.d.ts +5 -2
- package/dist-types/commands/PutBucketWebsiteCommand.d.ts +5 -2
- package/dist-types/commands/PutObjectAclCommand.d.ts +6 -3
- package/dist-types/commands/PutObjectCommand.d.ts +151 -114
- package/dist-types/commands/PutObjectLegalHoldCommand.d.ts +5 -2
- package/dist-types/commands/PutObjectLockConfigurationCommand.d.ts +4 -1
- package/dist-types/commands/PutObjectRetentionCommand.d.ts +5 -2
- package/dist-types/commands/PutObjectTaggingCommand.d.ts +4 -1
- package/dist-types/commands/PutPublicAccessBlockCommand.d.ts +4 -1
- package/dist-types/commands/RestoreObjectCommand.d.ts +6 -3
- package/dist-types/commands/SelectObjectContentCommand.d.ts +6 -3
- package/dist-types/commands/UploadPartCommand.d.ts +101 -62
- package/dist-types/commands/UploadPartCopyCommand.d.ts +121 -114
- package/dist-types/commands/WriteGetObjectResponseCommand.d.ts +5 -2
- package/dist-types/commands/index.d.ts +2 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +3 -0
- package/dist-types/models/models_0.d.ts +2443 -1104
- package/dist-types/models/models_1.d.ts +1189 -81
- package/dist-types/pagination/ListDirectoryBucketsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/protocols/Aws_restXml.d.ts +18 -0
- package/dist-types/runtimeConfig.browser.d.ts +2 -0
- package/dist-types/runtimeConfig.d.ts +2 -0
- package/dist-types/runtimeConfig.native.d.ts +2 -0
- package/dist-types/ts3.4/S3.d.ts +34 -0
- package/dist-types/ts3.4/S3Client.d.ts +12 -0
- package/dist-types/ts3.4/commands/CreateSessionCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/HeadBucketCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/ListDirectoryBucketsCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/PutBucketReplicationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/PutBucketRequestPaymentCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/PutBucketTaggingCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/PutBucketVersioningCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/PutBucketWebsiteCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/PutObjectCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/index.d.ts +2 -0
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +3 -0
- package/dist-types/ts3.4/models/models_0.d.ts +68 -124
- package/dist-types/ts3.4/models/models_1.d.ts +127 -1
- package/dist-types/ts3.4/pagination/ListDirectoryBucketsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/protocols/Aws_restXml.d.ts +24 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +7 -0
- package/dist-types/ts3.4/runtimeConfig.d.ts +6 -0
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +7 -0
- package/package.json +19 -19
|
@@ -1,7 +1,895 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { StreamingBlobTypes } from "@smithy/types";
|
|
3
|
-
import { AccessControlPolicy, ChecksumAlgorithm, Grant, ObjectCannedACL, ObjectLockConfiguration, ObjectLockLegalHold, ObjectLockLegalHoldStatus, ObjectLockMode, ObjectLockRetention, PublicAccessBlockConfiguration, ReplicationStatus, RequestCharged, RequestPayer, ServerSideEncryption, StorageClass,
|
|
3
|
+
import { AccessControlPolicy, BucketVersioningStatus, ChecksumAlgorithm, ErrorDocument, Grant, IndexDocument, ObjectCannedACL, ObjectLockConfiguration, ObjectLockLegalHold, ObjectLockLegalHoldStatus, ObjectLockMode, ObjectLockRetention, Payer, PublicAccessBlockConfiguration, RedirectAllRequestsTo, ReplicationConfiguration, ReplicationStatus, RequestCharged, RequestPayer, RoutingRule, ServerSideEncryption, StorageClass, Tag } from "./models_0";
|
|
4
4
|
import { S3ServiceException as __BaseException } from "./S3ServiceException";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export interface PutBucketReplicationRequest {
|
|
9
|
+
/**
|
|
10
|
+
* @public
|
|
11
|
+
* <p>The name of the bucket</p>
|
|
12
|
+
* <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.
|
|
13
|
+
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
14
|
+
*/
|
|
15
|
+
Bucket: string | undefined;
|
|
16
|
+
/**
|
|
17
|
+
* @public
|
|
18
|
+
* <p>The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message
|
|
19
|
+
* integrity check to verify that the request body was not corrupted in transit. For more
|
|
20
|
+
* information, see <a href="http://www.ietf.org/rfc/rfc1864.txt">RFC 1864</a>.</p>
|
|
21
|
+
* <p>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</p>
|
|
22
|
+
*/
|
|
23
|
+
ContentMD5?: string;
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any
|
|
27
|
+
* 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
|
|
28
|
+
* <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
|
|
29
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
|
|
30
|
+
* the <i>Amazon S3 User Guide</i>.</p>
|
|
31
|
+
* <p>If you provide an individual checksum, Amazon S3 ignores any provided
|
|
32
|
+
* <code>ChecksumAlgorithm</code> parameter.</p>
|
|
33
|
+
*/
|
|
34
|
+
ChecksumAlgorithm?: ChecksumAlgorithm;
|
|
35
|
+
/**
|
|
36
|
+
* @public
|
|
37
|
+
* <p>A container for replication rules. You can add up to 1,000 rules. The maximum size of a
|
|
38
|
+
* replication configuration is 2 MB.</p>
|
|
39
|
+
*/
|
|
40
|
+
ReplicationConfiguration: ReplicationConfiguration | undefined;
|
|
41
|
+
/**
|
|
42
|
+
* @public
|
|
43
|
+
* <p>A token to allow Object Lock to be enabled for an existing bucket.</p>
|
|
44
|
+
*/
|
|
45
|
+
Token?: string;
|
|
46
|
+
/**
|
|
47
|
+
* @public
|
|
48
|
+
* <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>
|
|
49
|
+
*/
|
|
50
|
+
ExpectedBucketOwner?: string;
|
|
51
|
+
}
|
|
52
|
+
/**
|
|
53
|
+
* @public
|
|
54
|
+
* <p>Container for Payer.</p>
|
|
55
|
+
*/
|
|
56
|
+
export interface RequestPaymentConfiguration {
|
|
57
|
+
/**
|
|
58
|
+
* @public
|
|
59
|
+
* <p>Specifies who pays for the download and request fees.</p>
|
|
60
|
+
*/
|
|
61
|
+
Payer: Payer | undefined;
|
|
62
|
+
}
|
|
63
|
+
/**
|
|
64
|
+
* @public
|
|
65
|
+
*/
|
|
66
|
+
export interface PutBucketRequestPaymentRequest {
|
|
67
|
+
/**
|
|
68
|
+
* @public
|
|
69
|
+
* <p>The bucket name.</p>
|
|
70
|
+
* <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.
|
|
71
|
+
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
72
|
+
*/
|
|
73
|
+
Bucket: string | undefined;
|
|
74
|
+
/**
|
|
75
|
+
* @public
|
|
76
|
+
* <p>The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message
|
|
77
|
+
* integrity check to verify that the request body was not corrupted in transit. For more
|
|
78
|
+
* information, see <a href="http://www.ietf.org/rfc/rfc1864.txt">RFC 1864</a>.</p>
|
|
79
|
+
* <p>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</p>
|
|
80
|
+
*/
|
|
81
|
+
ContentMD5?: string;
|
|
82
|
+
/**
|
|
83
|
+
* @public
|
|
84
|
+
* <p>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any
|
|
85
|
+
* 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
|
|
86
|
+
* <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
|
|
87
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
|
|
88
|
+
* the <i>Amazon S3 User Guide</i>.</p>
|
|
89
|
+
* <p>If you provide an individual checksum, Amazon S3 ignores any provided
|
|
90
|
+
* <code>ChecksumAlgorithm</code> parameter.</p>
|
|
91
|
+
*/
|
|
92
|
+
ChecksumAlgorithm?: ChecksumAlgorithm;
|
|
93
|
+
/**
|
|
94
|
+
* @public
|
|
95
|
+
* <p>Container for Payer.</p>
|
|
96
|
+
*/
|
|
97
|
+
RequestPaymentConfiguration: RequestPaymentConfiguration | undefined;
|
|
98
|
+
/**
|
|
99
|
+
* @public
|
|
100
|
+
* <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>
|
|
101
|
+
*/
|
|
102
|
+
ExpectedBucketOwner?: string;
|
|
103
|
+
}
|
|
104
|
+
/**
|
|
105
|
+
* @public
|
|
106
|
+
* <p>Container for <code>TagSet</code> elements.</p>
|
|
107
|
+
*/
|
|
108
|
+
export interface Tagging {
|
|
109
|
+
/**
|
|
110
|
+
* @public
|
|
111
|
+
* <p>A collection for a set of tags</p>
|
|
112
|
+
*/
|
|
113
|
+
TagSet: Tag[] | undefined;
|
|
114
|
+
}
|
|
115
|
+
/**
|
|
116
|
+
* @public
|
|
117
|
+
*/
|
|
118
|
+
export interface PutBucketTaggingRequest {
|
|
119
|
+
/**
|
|
120
|
+
* @public
|
|
121
|
+
* <p>The bucket name.</p>
|
|
122
|
+
* <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.
|
|
123
|
+
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
124
|
+
*/
|
|
125
|
+
Bucket: string | undefined;
|
|
126
|
+
/**
|
|
127
|
+
* @public
|
|
128
|
+
* <p>The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message
|
|
129
|
+
* integrity check to verify that the request body was not corrupted in transit. For more
|
|
130
|
+
* information, see <a href="http://www.ietf.org/rfc/rfc1864.txt">RFC 1864</a>.</p>
|
|
131
|
+
* <p>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</p>
|
|
132
|
+
*/
|
|
133
|
+
ContentMD5?: string;
|
|
134
|
+
/**
|
|
135
|
+
* @public
|
|
136
|
+
* <p>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any
|
|
137
|
+
* 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
|
+
* <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
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
|
|
140
|
+
* the <i>Amazon S3 User Guide</i>.</p>
|
|
141
|
+
* <p>If you provide an individual checksum, Amazon S3 ignores any provided
|
|
142
|
+
* <code>ChecksumAlgorithm</code> parameter.</p>
|
|
143
|
+
*/
|
|
144
|
+
ChecksumAlgorithm?: ChecksumAlgorithm;
|
|
145
|
+
/**
|
|
146
|
+
* @public
|
|
147
|
+
* <p>Container for the <code>TagSet</code> and <code>Tag</code> elements.</p>
|
|
148
|
+
*/
|
|
149
|
+
Tagging: Tagging | undefined;
|
|
150
|
+
/**
|
|
151
|
+
* @public
|
|
152
|
+
* <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
|
|
153
|
+
*/
|
|
154
|
+
ExpectedBucketOwner?: string;
|
|
155
|
+
}
|
|
156
|
+
/**
|
|
157
|
+
* @public
|
|
158
|
+
* @enum
|
|
159
|
+
*/
|
|
160
|
+
export declare const MFADelete: {
|
|
161
|
+
readonly Disabled: "Disabled";
|
|
162
|
+
readonly Enabled: "Enabled";
|
|
163
|
+
};
|
|
164
|
+
/**
|
|
165
|
+
* @public
|
|
166
|
+
*/
|
|
167
|
+
export type MFADelete = (typeof MFADelete)[keyof typeof MFADelete];
|
|
168
|
+
/**
|
|
169
|
+
* @public
|
|
170
|
+
* <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
|
|
171
|
+
* Bucket versioning</a> in the <i>Amazon S3 API Reference</i>.</p>
|
|
172
|
+
*/
|
|
173
|
+
export interface VersioningConfiguration {
|
|
174
|
+
/**
|
|
175
|
+
* @public
|
|
176
|
+
* <p>Specifies whether MFA delete is enabled in the bucket versioning configuration. This
|
|
177
|
+
* element is only returned if the bucket has been configured with MFA delete. If the bucket
|
|
178
|
+
* has never been so configured, this element is not returned.</p>
|
|
179
|
+
*/
|
|
180
|
+
MFADelete?: MFADelete;
|
|
181
|
+
/**
|
|
182
|
+
* @public
|
|
183
|
+
* <p>The versioning state of the bucket.</p>
|
|
184
|
+
*/
|
|
185
|
+
Status?: BucketVersioningStatus;
|
|
186
|
+
}
|
|
187
|
+
/**
|
|
188
|
+
* @public
|
|
189
|
+
*/
|
|
190
|
+
export interface PutBucketVersioningRequest {
|
|
191
|
+
/**
|
|
192
|
+
* @public
|
|
193
|
+
* <p>The bucket name.</p>
|
|
194
|
+
* <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.
|
|
195
|
+
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
196
|
+
*/
|
|
197
|
+
Bucket: string | undefined;
|
|
198
|
+
/**
|
|
199
|
+
* @public
|
|
200
|
+
* <p>>The base64-encoded 128-bit MD5 digest of the data. You must use this header as a
|
|
201
|
+
* message integrity check to verify that the request body was not corrupted in transit. For
|
|
202
|
+
* more information, see <a href="http://www.ietf.org/rfc/rfc1864.txt">RFC
|
|
203
|
+
* 1864</a>.</p>
|
|
204
|
+
* <p>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</p>
|
|
205
|
+
*/
|
|
206
|
+
ContentMD5?: string;
|
|
207
|
+
/**
|
|
208
|
+
* @public
|
|
209
|
+
* <p>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any
|
|
210
|
+
* 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
|
|
211
|
+
* <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
|
|
212
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
|
|
213
|
+
* the <i>Amazon S3 User Guide</i>.</p>
|
|
214
|
+
* <p>If you provide an individual checksum, Amazon S3 ignores any provided
|
|
215
|
+
* <code>ChecksumAlgorithm</code> parameter.</p>
|
|
216
|
+
*/
|
|
217
|
+
ChecksumAlgorithm?: ChecksumAlgorithm;
|
|
218
|
+
/**
|
|
219
|
+
* @public
|
|
220
|
+
* <p>The concatenation of the authentication device's serial number, a space, and the value
|
|
221
|
+
* that is displayed on your authentication device.</p>
|
|
222
|
+
*/
|
|
223
|
+
MFA?: string;
|
|
224
|
+
/**
|
|
225
|
+
* @public
|
|
226
|
+
* <p>Container for setting the versioning state.</p>
|
|
227
|
+
*/
|
|
228
|
+
VersioningConfiguration: VersioningConfiguration | undefined;
|
|
229
|
+
/**
|
|
230
|
+
* @public
|
|
231
|
+
* <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
|
|
232
|
+
*/
|
|
233
|
+
ExpectedBucketOwner?: string;
|
|
234
|
+
}
|
|
235
|
+
/**
|
|
236
|
+
* @public
|
|
237
|
+
* <p>Specifies website configuration parameters for an Amazon S3 bucket.</p>
|
|
238
|
+
*/
|
|
239
|
+
export interface WebsiteConfiguration {
|
|
240
|
+
/**
|
|
241
|
+
* @public
|
|
242
|
+
* <p>The name of the error document for the website.</p>
|
|
243
|
+
*/
|
|
244
|
+
ErrorDocument?: ErrorDocument;
|
|
245
|
+
/**
|
|
246
|
+
* @public
|
|
247
|
+
* <p>The name of the index document for the website.</p>
|
|
248
|
+
*/
|
|
249
|
+
IndexDocument?: IndexDocument;
|
|
250
|
+
/**
|
|
251
|
+
* @public
|
|
252
|
+
* <p>The redirect behavior for every request to this bucket's website endpoint.</p>
|
|
253
|
+
* <important>
|
|
254
|
+
* <p>If you specify this property, you can't specify any other property.</p>
|
|
255
|
+
* </important>
|
|
256
|
+
*/
|
|
257
|
+
RedirectAllRequestsTo?: RedirectAllRequestsTo;
|
|
258
|
+
/**
|
|
259
|
+
* @public
|
|
260
|
+
* <p>Rules that define when a redirect is applied and the redirect behavior.</p>
|
|
261
|
+
*/
|
|
262
|
+
RoutingRules?: RoutingRule[];
|
|
263
|
+
}
|
|
264
|
+
/**
|
|
265
|
+
* @public
|
|
266
|
+
*/
|
|
267
|
+
export interface PutBucketWebsiteRequest {
|
|
268
|
+
/**
|
|
269
|
+
* @public
|
|
270
|
+
* <p>The bucket name.</p>
|
|
271
|
+
* <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.
|
|
272
|
+
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
273
|
+
*/
|
|
274
|
+
Bucket: string | undefined;
|
|
275
|
+
/**
|
|
276
|
+
* @public
|
|
277
|
+
* <p>The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message
|
|
278
|
+
* integrity check to verify that the request body was not corrupted in transit. For more
|
|
279
|
+
* information, see <a href="http://www.ietf.org/rfc/rfc1864.txt">RFC 1864</a>.</p>
|
|
280
|
+
* <p>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</p>
|
|
281
|
+
*/
|
|
282
|
+
ContentMD5?: string;
|
|
283
|
+
/**
|
|
284
|
+
* @public
|
|
285
|
+
* <p>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any
|
|
286
|
+
* 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
|
|
287
|
+
* <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
|
|
288
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
|
|
289
|
+
* the <i>Amazon S3 User Guide</i>.</p>
|
|
290
|
+
* <p>If you provide an individual checksum, Amazon S3 ignores any provided
|
|
291
|
+
* <code>ChecksumAlgorithm</code> parameter.</p>
|
|
292
|
+
*/
|
|
293
|
+
ChecksumAlgorithm?: ChecksumAlgorithm;
|
|
294
|
+
/**
|
|
295
|
+
* @public
|
|
296
|
+
* <p>Container for the request.</p>
|
|
297
|
+
*/
|
|
298
|
+
WebsiteConfiguration: WebsiteConfiguration | undefined;
|
|
299
|
+
/**
|
|
300
|
+
* @public
|
|
301
|
+
* <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>
|
|
302
|
+
*/
|
|
303
|
+
ExpectedBucketOwner?: string;
|
|
304
|
+
}
|
|
305
|
+
/**
|
|
306
|
+
* @public
|
|
307
|
+
*/
|
|
308
|
+
export interface PutObjectOutput {
|
|
309
|
+
/**
|
|
310
|
+
* @public
|
|
311
|
+
* <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>, the response includes this header. It
|
|
312
|
+
* includes the <code>expiry-date</code> and <code>rule-id</code> key-value pairs that provide
|
|
313
|
+
* information about object expiration. The value of the <code>rule-id</code> is
|
|
314
|
+
* URL-encoded.</p>
|
|
315
|
+
* <note>
|
|
316
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
317
|
+
* </note>
|
|
318
|
+
*/
|
|
319
|
+
Expiration?: string;
|
|
320
|
+
/**
|
|
321
|
+
* @public
|
|
322
|
+
* <p>Entity tag for the uploaded object.</p>
|
|
323
|
+
* <p>
|
|
324
|
+
* <b>General purpose buckets </b> - To ensure that data is not corrupted traversing the network,
|
|
325
|
+
* for objects where the
|
|
326
|
+
* ETag is the MD5 digest of the object, you can calculate the MD5 while putting an object to Amazon S3 and compare the returned ETag to
|
|
327
|
+
* the calculated MD5 value.</p>
|
|
328
|
+
* <p>
|
|
329
|
+
* <b>Directory buckets </b> - The ETag for the object in a directory bucket isn't the MD5 digest of the object.</p>
|
|
330
|
+
*/
|
|
331
|
+
ETag?: string;
|
|
332
|
+
/**
|
|
333
|
+
* @public
|
|
334
|
+
* <p>The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded
|
|
335
|
+
* 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
|
|
336
|
+
* with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums">
|
|
337
|
+
* Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
338
|
+
*/
|
|
339
|
+
ChecksumCRC32?: string;
|
|
340
|
+
/**
|
|
341
|
+
* @public
|
|
342
|
+
* <p>The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded
|
|
343
|
+
* 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
|
|
344
|
+
* with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums">
|
|
345
|
+
* Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
346
|
+
*/
|
|
347
|
+
ChecksumCRC32C?: string;
|
|
348
|
+
/**
|
|
349
|
+
* @public
|
|
350
|
+
* <p>The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded
|
|
351
|
+
* 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
|
|
352
|
+
* with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums">
|
|
353
|
+
* Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
354
|
+
*/
|
|
355
|
+
ChecksumSHA1?: string;
|
|
356
|
+
/**
|
|
357
|
+
* @public
|
|
358
|
+
* <p>The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded
|
|
359
|
+
* 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
|
|
360
|
+
* with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums">
|
|
361
|
+
* Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
362
|
+
*/
|
|
363
|
+
ChecksumSHA256?: string;
|
|
364
|
+
/**
|
|
365
|
+
* @public
|
|
366
|
+
* <p>The server-side encryption algorithm used when you store this object in Amazon S3 (for example,
|
|
367
|
+
* <code>AES256</code>, <code>aws:kms</code>, <code>aws:kms:dsse</code>).</p>
|
|
368
|
+
* <note>
|
|
369
|
+
* <p>For directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) (<code>AES256</code>) is supported.</p>
|
|
370
|
+
* </note>
|
|
371
|
+
*/
|
|
372
|
+
ServerSideEncryption?: ServerSideEncryption;
|
|
373
|
+
/**
|
|
374
|
+
* @public
|
|
375
|
+
* <p>Version ID of the object.</p>
|
|
376
|
+
* <p>If you enable versioning for a bucket, Amazon S3 automatically generates a unique version ID
|
|
377
|
+
* for the object being stored. Amazon S3 returns this ID in the response. When you enable
|
|
378
|
+
* versioning for a bucket, if Amazon S3 receives multiple write requests for the same object
|
|
379
|
+
* simultaneously, it stores all of the objects. For more information about versioning, see
|
|
380
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/AddingObjectstoVersioningEnabledBuckets.html">Adding Objects to
|
|
381
|
+
* Versioning-Enabled Buckets</a> in the <i>Amazon S3
|
|
382
|
+
* User Guide</i>. For information about returning the versioning state
|
|
383
|
+
* of a bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html">GetBucketVersioning</a>. </p>
|
|
384
|
+
* <note>
|
|
385
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
386
|
+
* </note>
|
|
387
|
+
*/
|
|
388
|
+
VersionId?: string;
|
|
389
|
+
/**
|
|
390
|
+
* @public
|
|
391
|
+
* <p>If server-side encryption with a customer-provided encryption key was requested, the
|
|
392
|
+
* response will include this header to confirm the encryption algorithm that's used.</p>
|
|
393
|
+
* <note>
|
|
394
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
395
|
+
* </note>
|
|
396
|
+
*/
|
|
397
|
+
SSECustomerAlgorithm?: string;
|
|
398
|
+
/**
|
|
399
|
+
* @public
|
|
400
|
+
* <p>If server-side encryption with a customer-provided encryption key was requested, the
|
|
401
|
+
* response will include this header to provide the round-trip message integrity verification of
|
|
402
|
+
* the customer-provided encryption key.</p>
|
|
403
|
+
* <note>
|
|
404
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
405
|
+
* </note>
|
|
406
|
+
*/
|
|
407
|
+
SSECustomerKeyMD5?: string;
|
|
408
|
+
/**
|
|
409
|
+
* @public
|
|
410
|
+
* <p>If <code>x-amz-server-side-encryption</code> has a valid value of <code>aws:kms</code>
|
|
411
|
+
* or <code>aws:kms:dsse</code>, this header indicates the ID of the Key Management Service (KMS)
|
|
412
|
+
* symmetric encryption customer managed key that was used for the object. </p>
|
|
413
|
+
* <note>
|
|
414
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
415
|
+
* </note>
|
|
416
|
+
*/
|
|
417
|
+
SSEKMSKeyId?: string;
|
|
418
|
+
/**
|
|
419
|
+
* @public
|
|
420
|
+
* <p>If present, indicates the Amazon Web Services KMS Encryption Context to use for object encryption. The
|
|
421
|
+
* value of this header is a base64-encoded UTF-8 string holding JSON with the encryption
|
|
422
|
+
* context key-value pairs. This value is stored as object metadata and automatically gets
|
|
423
|
+
* passed on to Amazon Web Services KMS for future <code>GetObject</code> or <code>CopyObject</code>
|
|
424
|
+
* operations on this object.</p>
|
|
425
|
+
* <note>
|
|
426
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
427
|
+
* </note>
|
|
428
|
+
*/
|
|
429
|
+
SSEKMSEncryptionContext?: string;
|
|
430
|
+
/**
|
|
431
|
+
* @public
|
|
432
|
+
* <p>Indicates whether the uploaded object uses an S3 Bucket Key for server-side encryption
|
|
433
|
+
* with Key Management Service (KMS) keys (SSE-KMS).</p>
|
|
434
|
+
* <note>
|
|
435
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
436
|
+
* </note>
|
|
437
|
+
*/
|
|
438
|
+
BucketKeyEnabled?: boolean;
|
|
439
|
+
/**
|
|
440
|
+
* @public
|
|
441
|
+
* <p>If present, indicates that the requester was successfully charged for the
|
|
442
|
+
* request.</p>
|
|
443
|
+
* <note>
|
|
444
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
445
|
+
* </note>
|
|
446
|
+
*/
|
|
447
|
+
RequestCharged?: RequestCharged;
|
|
448
|
+
}
|
|
449
|
+
/**
|
|
450
|
+
* @public
|
|
451
|
+
*/
|
|
452
|
+
export interface PutObjectRequest {
|
|
453
|
+
/**
|
|
454
|
+
* @public
|
|
455
|
+
* <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
|
|
456
|
+
* ACL</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
457
|
+
* <p>When adding a new object, you can use headers to grant ACL-based permissions to
|
|
458
|
+
* individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are
|
|
459
|
+
* then added to the ACL on the object. By default, all objects are private. Only the owner
|
|
460
|
+
* 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>
|
|
461
|
+
* and <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-using-rest-api.html">Managing
|
|
462
|
+
* ACLs Using the REST API</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
463
|
+
* <p>If the bucket that you're uploading objects to uses the bucket owner enforced setting
|
|
464
|
+
* for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that
|
|
465
|
+
* use this setting only accept PUT requests that don't specify an ACL or PUT requests that
|
|
466
|
+
* specify bucket owner full control ACLs, such as the <code>bucket-owner-full-control</code>
|
|
467
|
+
* canned ACL or an equivalent form of this ACL expressed in the XML format. PUT requests that
|
|
468
|
+
* contain other ACLs (for example, custom grants to certain Amazon Web Services accounts) fail and return a
|
|
469
|
+
* <code>400</code> error with the error code <code>AccessControlListNotSupported</code>.
|
|
470
|
+
* For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html"> Controlling ownership of
|
|
471
|
+
* objects and disabling ACLs</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
472
|
+
* <note>
|
|
473
|
+
* <ul>
|
|
474
|
+
* <li>
|
|
475
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
476
|
+
* </li>
|
|
477
|
+
* <li>
|
|
478
|
+
* <p>This functionality is not supported for Amazon S3 on Outposts.</p>
|
|
479
|
+
* </li>
|
|
480
|
+
* </ul>
|
|
481
|
+
* </note>
|
|
482
|
+
*/
|
|
483
|
+
ACL?: ObjectCannedACL;
|
|
484
|
+
/**
|
|
485
|
+
* @public
|
|
486
|
+
* <p>Object data.</p>
|
|
487
|
+
*/
|
|
488
|
+
Body?: StreamingBlobTypes;
|
|
489
|
+
/**
|
|
490
|
+
* @public
|
|
491
|
+
* <p>The bucket name to which the PUT action was initiated. </p>
|
|
492
|
+
* <p>
|
|
493
|
+
* <b>Directory buckets</b> - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code>
|
|
494
|
+
* <i>Bucket_name</i>.s3express-<i>az_id</i>.<i>region</i>.amazonaws.com</code>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format <code>
|
|
495
|
+
* <i>bucket_base_name</i>--<i>az-id</i>--x-s3</code> (for example, <code>
|
|
496
|
+
* <i>DOC-EXAMPLE-BUCKET</i>--<i>usw2-az2</i>--x-s3</code>). For information about bucket naming
|
|
497
|
+
* restrictions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html">Directory bucket naming
|
|
498
|
+
* rules</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
499
|
+
* <p>
|
|
500
|
+
* <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>
|
|
501
|
+
* <note>
|
|
502
|
+
* <p>Access points and Object Lambda access points are not supported by directory buckets.</p>
|
|
503
|
+
* </note>
|
|
504
|
+
* <p>
|
|
505
|
+
* <b>S3 on Outposts</b> - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code>
|
|
506
|
+
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
507
|
+
* <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.
|
|
508
|
+
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
509
|
+
*/
|
|
510
|
+
Bucket: string | undefined;
|
|
511
|
+
/**
|
|
512
|
+
* @public
|
|
513
|
+
* <p>Can be used to specify caching behavior along the request/reply chain. For more
|
|
514
|
+
* 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>
|
|
515
|
+
*/
|
|
516
|
+
CacheControl?: string;
|
|
517
|
+
/**
|
|
518
|
+
* @public
|
|
519
|
+
* <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>
|
|
520
|
+
*/
|
|
521
|
+
ContentDisposition?: string;
|
|
522
|
+
/**
|
|
523
|
+
* @public
|
|
524
|
+
* <p>Specifies what content encodings have been applied to the object and thus what decoding
|
|
525
|
+
* mechanisms must be applied to obtain the media-type referenced by the Content-Type header
|
|
526
|
+
* 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>
|
|
527
|
+
*/
|
|
528
|
+
ContentEncoding?: string;
|
|
529
|
+
/**
|
|
530
|
+
* @public
|
|
531
|
+
* <p>The language the content is in.</p>
|
|
532
|
+
*/
|
|
533
|
+
ContentLanguage?: string;
|
|
534
|
+
/**
|
|
535
|
+
* @public
|
|
536
|
+
* <p>Size of the body in bytes. This parameter is useful when the size of the body cannot be
|
|
537
|
+
* 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>
|
|
538
|
+
*/
|
|
539
|
+
ContentLength?: number;
|
|
540
|
+
/**
|
|
541
|
+
* @public
|
|
542
|
+
* <p>The base64-encoded 128-bit MD5 digest of the message (without the headers) according to
|
|
543
|
+
* RFC 1864. This header can be used as a message integrity check to verify that the data is
|
|
544
|
+
* the same data that was originally sent. Although it is optional, we recommend using the
|
|
545
|
+
* Content-MD5 mechanism as an end-to-end integrity check. For more information about REST
|
|
546
|
+
* request authentication, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html">REST Authentication</a>.</p>
|
|
547
|
+
* <note>
|
|
548
|
+
* <p>The <code>Content-MD5</code> header is required for any request to upload an
|
|
549
|
+
* object with a retention period configured using Amazon S3 Object Lock. For more
|
|
550
|
+
* information about Amazon S3 Object Lock, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock-overview.html">Amazon S3 Object Lock
|
|
551
|
+
* Overview</a> in the <i>Amazon S3 User Guide</i>. </p>
|
|
552
|
+
* </note>
|
|
553
|
+
* <note>
|
|
554
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
555
|
+
* </note>
|
|
556
|
+
*/
|
|
557
|
+
ContentMD5?: string;
|
|
558
|
+
/**
|
|
559
|
+
* @public
|
|
560
|
+
* <p>A standard MIME type describing the format of the contents. For more information, see
|
|
561
|
+
* <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>
|
|
562
|
+
*/
|
|
563
|
+
ContentType?: string;
|
|
564
|
+
/**
|
|
565
|
+
* @public
|
|
566
|
+
* <p>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any
|
|
567
|
+
* 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>
|
|
568
|
+
* </code> or
|
|
569
|
+
* <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>.</p>
|
|
570
|
+
* <p>For the <code>x-amz-checksum-<i>algorithm</i>
|
|
571
|
+
* </code> header, replace <code>
|
|
572
|
+
* <i>algorithm</i>
|
|
573
|
+
* </code> with the supported algorithm from the following list: </p>
|
|
574
|
+
* <ul>
|
|
575
|
+
* <li>
|
|
576
|
+
* <p>CRC32</p>
|
|
577
|
+
* </li>
|
|
578
|
+
* <li>
|
|
579
|
+
* <p>CRC32C</p>
|
|
580
|
+
* </li>
|
|
581
|
+
* <li>
|
|
582
|
+
* <p>SHA1</p>
|
|
583
|
+
* </li>
|
|
584
|
+
* <li>
|
|
585
|
+
* <p>SHA256</p>
|
|
586
|
+
* </li>
|
|
587
|
+
* </ul>
|
|
588
|
+
* <p>For more
|
|
589
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
|
|
590
|
+
* the <i>Amazon S3 User Guide</i>.</p>
|
|
591
|
+
* <p>If the individual checksum value you provide through <code>x-amz-checksum-<i>algorithm</i>
|
|
592
|
+
* </code> doesn't match the checksum algorithm you set through <code>x-amz-sdk-checksum-algorithm</code>, Amazon S3 ignores any provided
|
|
593
|
+
* <code>ChecksumAlgorithm</code> parameter and uses the checksum algorithm that matches the provided value in <code>x-amz-checksum-<i>algorithm</i>
|
|
594
|
+
* </code>.</p>
|
|
595
|
+
* <note>
|
|
596
|
+
* <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>
|
|
597
|
+
* </note>
|
|
598
|
+
*/
|
|
599
|
+
ChecksumAlgorithm?: ChecksumAlgorithm;
|
|
600
|
+
/**
|
|
601
|
+
* @public
|
|
602
|
+
* <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.
|
|
603
|
+
* This header specifies the base64-encoded, 32-bit CRC32 checksum of the object. For more information, see
|
|
604
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in the
|
|
605
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
606
|
+
*/
|
|
607
|
+
ChecksumCRC32?: string;
|
|
608
|
+
/**
|
|
609
|
+
* @public
|
|
610
|
+
* <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.
|
|
611
|
+
* This header specifies the base64-encoded, 32-bit CRC32C checksum of the object. For more information, see
|
|
612
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in the
|
|
613
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
614
|
+
*/
|
|
615
|
+
ChecksumCRC32C?: string;
|
|
616
|
+
/**
|
|
617
|
+
* @public
|
|
618
|
+
* <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.
|
|
619
|
+
* This header specifies the base64-encoded, 160-bit SHA-1 digest of the object. For more information, see
|
|
620
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in the
|
|
621
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
622
|
+
*/
|
|
623
|
+
ChecksumSHA1?: string;
|
|
624
|
+
/**
|
|
625
|
+
* @public
|
|
626
|
+
* <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.
|
|
627
|
+
* This header specifies the base64-encoded, 256-bit SHA-256 digest of the object. For more information, see
|
|
628
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in the
|
|
629
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
630
|
+
*/
|
|
631
|
+
ChecksumSHA256?: string;
|
|
632
|
+
/**
|
|
633
|
+
* @public
|
|
634
|
+
* <p>The date and time at which the object is no longer cacheable. For more information, see
|
|
635
|
+
* <a href="https://www.rfc-editor.org/rfc/rfc7234#section-5.3">https://www.rfc-editor.org/rfc/rfc7234#section-5.3</a>.</p>
|
|
636
|
+
*/
|
|
637
|
+
Expires?: Date;
|
|
638
|
+
/**
|
|
639
|
+
* @public
|
|
640
|
+
* <p>Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.</p>
|
|
641
|
+
* <note>
|
|
642
|
+
* <ul>
|
|
643
|
+
* <li>
|
|
644
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
645
|
+
* </li>
|
|
646
|
+
* <li>
|
|
647
|
+
* <p>This functionality is not supported for Amazon S3 on Outposts.</p>
|
|
648
|
+
* </li>
|
|
649
|
+
* </ul>
|
|
650
|
+
* </note>
|
|
651
|
+
*/
|
|
652
|
+
GrantFullControl?: string;
|
|
653
|
+
/**
|
|
654
|
+
* @public
|
|
655
|
+
* <p>Allows grantee to read the object data and its metadata.</p>
|
|
656
|
+
* <note>
|
|
657
|
+
* <ul>
|
|
658
|
+
* <li>
|
|
659
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
660
|
+
* </li>
|
|
661
|
+
* <li>
|
|
662
|
+
* <p>This functionality is not supported for Amazon S3 on Outposts.</p>
|
|
663
|
+
* </li>
|
|
664
|
+
* </ul>
|
|
665
|
+
* </note>
|
|
666
|
+
*/
|
|
667
|
+
GrantRead?: string;
|
|
668
|
+
/**
|
|
669
|
+
* @public
|
|
670
|
+
* <p>Allows grantee to read the object ACL.</p>
|
|
671
|
+
* <note>
|
|
672
|
+
* <ul>
|
|
673
|
+
* <li>
|
|
674
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
675
|
+
* </li>
|
|
676
|
+
* <li>
|
|
677
|
+
* <p>This functionality is not supported for Amazon S3 on Outposts.</p>
|
|
678
|
+
* </li>
|
|
679
|
+
* </ul>
|
|
680
|
+
* </note>
|
|
681
|
+
*/
|
|
682
|
+
GrantReadACP?: string;
|
|
683
|
+
/**
|
|
684
|
+
* @public
|
|
685
|
+
* <p>Allows grantee to write the ACL for the applicable object.</p>
|
|
686
|
+
* <note>
|
|
687
|
+
* <ul>
|
|
688
|
+
* <li>
|
|
689
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
690
|
+
* </li>
|
|
691
|
+
* <li>
|
|
692
|
+
* <p>This functionality is not supported for Amazon S3 on Outposts.</p>
|
|
693
|
+
* </li>
|
|
694
|
+
* </ul>
|
|
695
|
+
* </note>
|
|
696
|
+
*/
|
|
697
|
+
GrantWriteACP?: string;
|
|
698
|
+
/**
|
|
699
|
+
* @public
|
|
700
|
+
* <p>Object key for which the PUT action was initiated.</p>
|
|
701
|
+
*/
|
|
702
|
+
Key: string | undefined;
|
|
703
|
+
/**
|
|
704
|
+
* @public
|
|
705
|
+
* <p>A map of metadata to store with the object in S3.</p>
|
|
706
|
+
*/
|
|
707
|
+
Metadata?: Record<string, string>;
|
|
708
|
+
/**
|
|
709
|
+
* @public
|
|
710
|
+
* <p>The server-side encryption algorithm that was used when you store this object in Amazon S3 (for example,
|
|
711
|
+
* <code>AES256</code>, <code>aws:kms</code>, <code>aws:kms:dsse</code>).</p>
|
|
712
|
+
* <p>
|
|
713
|
+
* <b>General purpose buckets </b> - You have four mutually exclusive options to protect data using server-side encryption in
|
|
714
|
+
* Amazon S3, depending on how you choose to manage the encryption keys. Specifically, the
|
|
715
|
+
* encryption key options are Amazon S3 managed keys (SSE-S3), Amazon Web Services KMS keys (SSE-KMS or
|
|
716
|
+
* DSSE-KMS), and customer-provided keys (SSE-C). Amazon S3 encrypts data with server-side
|
|
717
|
+
* encryption by using Amazon S3 managed keys (SSE-S3) by default. You can optionally tell Amazon S3 to
|
|
718
|
+
* encrypt data at rest by using server-side encryption with other key options. For more
|
|
719
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html">Using Server-Side
|
|
720
|
+
* Encryption</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
721
|
+
* <p>
|
|
722
|
+
* <b>Directory buckets </b> - For directory buckets, only the server-side encryption with Amazon S3 managed keys (SSE-S3) (<code>AES256</code>) value is supported.</p>
|
|
723
|
+
*/
|
|
724
|
+
ServerSideEncryption?: ServerSideEncryption;
|
|
725
|
+
/**
|
|
726
|
+
* @public
|
|
727
|
+
* <p>By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The
|
|
728
|
+
* STANDARD storage class provides high durability and high availability. Depending on
|
|
729
|
+
* performance needs, you can specify a different Storage Class. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html">Storage Classes</a> in the
|
|
730
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
731
|
+
* <note>
|
|
732
|
+
* <ul>
|
|
733
|
+
* <li>
|
|
734
|
+
* <p>For directory buckets, only the S3 Express One Zone storage class is supported to store newly created objects.</p>
|
|
735
|
+
* </li>
|
|
736
|
+
* <li>
|
|
737
|
+
* <p>Amazon S3 on Outposts only uses
|
|
738
|
+
* the OUTPOSTS Storage Class.</p>
|
|
739
|
+
* </li>
|
|
740
|
+
* </ul>
|
|
741
|
+
* </note>
|
|
742
|
+
*/
|
|
743
|
+
StorageClass?: StorageClass;
|
|
744
|
+
/**
|
|
745
|
+
* @public
|
|
746
|
+
* <p>If the bucket is configured as a website, redirects requests for this object to another
|
|
747
|
+
* object in the same bucket or to an external URL. Amazon S3 stores the value of this header in
|
|
748
|
+
* 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 <i>Amazon S3
|
|
749
|
+
* User Guide</i>.</p>
|
|
750
|
+
* <p>In the following example, the request header sets the redirect to an object
|
|
751
|
+
* (anotherPage.html) in the same bucket:</p>
|
|
752
|
+
* <p>
|
|
753
|
+
* <code>x-amz-website-redirect-location: /anotherPage.html</code>
|
|
754
|
+
* </p>
|
|
755
|
+
* <p>In the following example, the request header sets the object redirect to another
|
|
756
|
+
* website:</p>
|
|
757
|
+
* <p>
|
|
758
|
+
* <code>x-amz-website-redirect-location: http://www.example.com/</code>
|
|
759
|
+
* </p>
|
|
760
|
+
* <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
|
|
761
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html">How to
|
|
762
|
+
* Configure Website Page Redirects</a> in the <i>Amazon S3
|
|
763
|
+
* User Guide</i>. </p>
|
|
764
|
+
* <note>
|
|
765
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
766
|
+
* </note>
|
|
767
|
+
*/
|
|
768
|
+
WebsiteRedirectLocation?: string;
|
|
769
|
+
/**
|
|
770
|
+
* @public
|
|
771
|
+
* <p>Specifies the algorithm to use when encrypting the object (for example,
|
|
772
|
+
* <code>AES256</code>).</p>
|
|
773
|
+
* <note>
|
|
774
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
775
|
+
* </note>
|
|
776
|
+
*/
|
|
777
|
+
SSECustomerAlgorithm?: string;
|
|
778
|
+
/**
|
|
779
|
+
* @public
|
|
780
|
+
* <p>Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This
|
|
781
|
+
* value is used to store the object and then it is discarded; Amazon S3 does not store the
|
|
782
|
+
* encryption key. The key must be appropriate for use with the algorithm specified in the
|
|
783
|
+
* <code>x-amz-server-side-encryption-customer-algorithm</code> header.</p>
|
|
784
|
+
* <note>
|
|
785
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
786
|
+
* </note>
|
|
787
|
+
*/
|
|
788
|
+
SSECustomerKey?: string;
|
|
789
|
+
/**
|
|
790
|
+
* @public
|
|
791
|
+
* <p>Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses
|
|
792
|
+
* this header for a message integrity check to ensure that the encryption key was transmitted
|
|
793
|
+
* without error.</p>
|
|
794
|
+
* <note>
|
|
795
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
796
|
+
* </note>
|
|
797
|
+
*/
|
|
798
|
+
SSECustomerKeyMD5?: string;
|
|
799
|
+
/**
|
|
800
|
+
* @public
|
|
801
|
+
* <p>If <code>x-amz-server-side-encryption</code> has a valid value of <code>aws:kms</code>
|
|
802
|
+
* or <code>aws:kms:dsse</code>, this header specifies the ID (Key ID, Key ARN, or Key Alias) of the Key Management Service (KMS)
|
|
803
|
+
* symmetric encryption customer managed key that was used for the object. If you specify
|
|
804
|
+
* <code>x-amz-server-side-encryption:aws:kms</code> or
|
|
805
|
+
* <code>x-amz-server-side-encryption:aws:kms:dsse</code>, but do not provide<code>
|
|
806
|
+
* x-amz-server-side-encryption-aws-kms-key-id</code>, Amazon S3 uses the Amazon Web Services managed key
|
|
807
|
+
* (<code>aws/s3</code>) to protect the data. If the KMS key does not exist in the same
|
|
808
|
+
* account that's issuing the command, you must use the full ARN and not just the ID. </p>
|
|
809
|
+
* <note>
|
|
810
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
811
|
+
* </note>
|
|
812
|
+
*/
|
|
813
|
+
SSEKMSKeyId?: string;
|
|
814
|
+
/**
|
|
815
|
+
* @public
|
|
816
|
+
* <p>Specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of
|
|
817
|
+
* this header is a base64-encoded UTF-8 string holding JSON with the encryption context
|
|
818
|
+
* key-value pairs. This value is stored as object metadata and automatically gets passed on
|
|
819
|
+
* to Amazon Web Services KMS for future <code>GetObject</code> or <code>CopyObject</code> operations on
|
|
820
|
+
* this object. This value must be explicitly added during <code>CopyObject</code> operations.</p>
|
|
821
|
+
* <note>
|
|
822
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
823
|
+
* </note>
|
|
824
|
+
*/
|
|
825
|
+
SSEKMSEncryptionContext?: string;
|
|
826
|
+
/**
|
|
827
|
+
* @public
|
|
828
|
+
* <p>Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with
|
|
829
|
+
* server-side encryption using Key Management Service (KMS) keys (SSE-KMS). Setting this header to
|
|
830
|
+
* <code>true</code> causes Amazon S3 to use an S3 Bucket Key for object encryption with
|
|
831
|
+
* SSE-KMS.</p>
|
|
832
|
+
* <p>Specifying this header with a PUT action doesn’t affect bucket-level settings for S3
|
|
833
|
+
* Bucket Key.</p>
|
|
834
|
+
* <note>
|
|
835
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
836
|
+
* </note>
|
|
837
|
+
*/
|
|
838
|
+
BucketKeyEnabled?: boolean;
|
|
839
|
+
/**
|
|
840
|
+
* @public
|
|
841
|
+
* <p>Confirms that the requester knows that they will be charged for the request. Bucket
|
|
842
|
+
* owners need not specify this parameter in their requests. If either the source or
|
|
843
|
+
* destination S3 bucket has Requester Pays enabled, the requester will pay for
|
|
844
|
+
* corresponding charges to copy the object. For information about downloading objects from
|
|
845
|
+
* Requester Pays buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in
|
|
846
|
+
* Requester Pays Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
847
|
+
* <note>
|
|
848
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
849
|
+
* </note>
|
|
850
|
+
*/
|
|
851
|
+
RequestPayer?: RequestPayer;
|
|
852
|
+
/**
|
|
853
|
+
* @public
|
|
854
|
+
* <p>The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For
|
|
855
|
+
* example, "Key1=Value1")</p>
|
|
856
|
+
* <note>
|
|
857
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
858
|
+
* </note>
|
|
859
|
+
*/
|
|
860
|
+
Tagging?: string;
|
|
861
|
+
/**
|
|
862
|
+
* @public
|
|
863
|
+
* <p>The Object Lock mode that you want to apply to this object.</p>
|
|
864
|
+
* <note>
|
|
865
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
866
|
+
* </note>
|
|
867
|
+
*/
|
|
868
|
+
ObjectLockMode?: ObjectLockMode;
|
|
869
|
+
/**
|
|
870
|
+
* @public
|
|
871
|
+
* <p>The date and time when you want this object's Object Lock to expire. Must be formatted
|
|
872
|
+
* as a timestamp parameter.</p>
|
|
873
|
+
* <note>
|
|
874
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
875
|
+
* </note>
|
|
876
|
+
*/
|
|
877
|
+
ObjectLockRetainUntilDate?: Date;
|
|
878
|
+
/**
|
|
879
|
+
* @public
|
|
880
|
+
* <p>Specifies whether a legal hold will be applied to this object. For more information
|
|
881
|
+
* about S3 Object Lock, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Object Lock</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
882
|
+
* <note>
|
|
883
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
884
|
+
* </note>
|
|
885
|
+
*/
|
|
886
|
+
ObjectLockLegalHoldStatus?: ObjectLockLegalHoldStatus;
|
|
887
|
+
/**
|
|
888
|
+
* @public
|
|
889
|
+
* <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>
|
|
890
|
+
*/
|
|
891
|
+
ExpectedBucketOwner?: string;
|
|
892
|
+
}
|
|
5
893
|
/**
|
|
6
894
|
* @public
|
|
7
895
|
*/
|
|
@@ -10,6 +898,9 @@ export interface PutObjectAclOutput {
|
|
|
10
898
|
* @public
|
|
11
899
|
* <p>If present, indicates that the requester was successfully charged for the
|
|
12
900
|
* request.</p>
|
|
901
|
+
* <note>
|
|
902
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
903
|
+
* </note>
|
|
13
904
|
*/
|
|
14
905
|
RequestCharged?: RequestCharged;
|
|
15
906
|
}
|
|
@@ -31,7 +922,11 @@ export interface PutObjectAclRequest {
|
|
|
31
922
|
/**
|
|
32
923
|
* @public
|
|
33
924
|
* <p>The bucket name that contains the object to which you want to attach the ACL. </p>
|
|
34
|
-
* <p>
|
|
925
|
+
* <p>
|
|
926
|
+
* <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>
|
|
927
|
+
* <p>
|
|
928
|
+
* <b>S3 on Outposts</b> - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code>
|
|
929
|
+
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
35
930
|
* <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.
|
|
36
931
|
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
37
932
|
*/
|
|
@@ -48,8 +943,8 @@ export interface PutObjectAclRequest {
|
|
|
48
943
|
ContentMD5?: string;
|
|
49
944
|
/**
|
|
50
945
|
* @public
|
|
51
|
-
* <p>Indicates the algorithm used to create the checksum for the object when
|
|
52
|
-
* additional functionality if
|
|
946
|
+
* <p>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any
|
|
947
|
+
* 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
|
|
53
948
|
* <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
|
|
54
949
|
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
|
|
55
950
|
* the <i>Amazon S3 User Guide</i>.</p>
|
|
@@ -61,19 +956,19 @@ export interface PutObjectAclRequest {
|
|
|
61
956
|
* @public
|
|
62
957
|
* <p>Allows grantee the read, write, read ACP, and write ACP permissions on the
|
|
63
958
|
* bucket.</p>
|
|
64
|
-
* <p>This
|
|
959
|
+
* <p>This functionality is not supported for Amazon S3 on Outposts.</p>
|
|
65
960
|
*/
|
|
66
961
|
GrantFullControl?: string;
|
|
67
962
|
/**
|
|
68
963
|
* @public
|
|
69
964
|
* <p>Allows grantee to list the objects in the bucket.</p>
|
|
70
|
-
* <p>This
|
|
965
|
+
* <p>This functionality is not supported for Amazon S3 on Outposts.</p>
|
|
71
966
|
*/
|
|
72
967
|
GrantRead?: string;
|
|
73
968
|
/**
|
|
74
969
|
* @public
|
|
75
970
|
* <p>Allows grantee to read the bucket ACL.</p>
|
|
76
|
-
* <p>This
|
|
971
|
+
* <p>This functionality is not supported for Amazon S3 on Outposts.</p>
|
|
77
972
|
*/
|
|
78
973
|
GrantReadACP?: string;
|
|
79
974
|
/**
|
|
@@ -86,35 +981,38 @@ export interface PutObjectAclRequest {
|
|
|
86
981
|
/**
|
|
87
982
|
* @public
|
|
88
983
|
* <p>Allows grantee to write the ACL for the applicable bucket.</p>
|
|
89
|
-
* <p>This
|
|
984
|
+
* <p>This functionality is not supported for Amazon S3 on Outposts.</p>
|
|
90
985
|
*/
|
|
91
986
|
GrantWriteACP?: string;
|
|
92
987
|
/**
|
|
93
988
|
* @public
|
|
94
989
|
* <p>Key for which the PUT action was initiated.</p>
|
|
95
|
-
* <p>When using this action with an access point, 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>
|
|
96
|
-
* <p>When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code>
|
|
97
|
-
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
98
990
|
*/
|
|
99
991
|
Key: string | undefined;
|
|
100
992
|
/**
|
|
101
993
|
* @public
|
|
102
994
|
* <p>Confirms that the requester knows that they will be charged for the request. Bucket
|
|
103
995
|
* owners need not specify this parameter in their requests. If either the source or
|
|
104
|
-
* destination
|
|
996
|
+
* destination S3 bucket has Requester Pays enabled, the requester will pay for
|
|
105
997
|
* corresponding charges to copy the object. For information about downloading objects from
|
|
106
998
|
* Requester Pays buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in
|
|
107
999
|
* Requester Pays Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1000
|
+
* <note>
|
|
1001
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
1002
|
+
* </note>
|
|
108
1003
|
*/
|
|
109
1004
|
RequestPayer?: RequestPayer;
|
|
110
1005
|
/**
|
|
111
1006
|
* @public
|
|
112
|
-
* <p>
|
|
1007
|
+
* <p>Version ID used to reference a specific version of the object.</p>
|
|
1008
|
+
* <note>
|
|
1009
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
1010
|
+
* </note>
|
|
113
1011
|
*/
|
|
114
1012
|
VersionId?: string;
|
|
115
1013
|
/**
|
|
116
1014
|
* @public
|
|
117
|
-
* <p>The account ID of the expected bucket owner. If the
|
|
1015
|
+
* <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>
|
|
118
1016
|
*/
|
|
119
1017
|
ExpectedBucketOwner?: string;
|
|
120
1018
|
}
|
|
@@ -126,6 +1024,9 @@ export interface PutObjectLegalHoldOutput {
|
|
|
126
1024
|
* @public
|
|
127
1025
|
* <p>If present, indicates that the requester was successfully charged for the
|
|
128
1026
|
* request.</p>
|
|
1027
|
+
* <note>
|
|
1028
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
1029
|
+
* </note>
|
|
129
1030
|
*/
|
|
130
1031
|
RequestCharged?: RequestCharged;
|
|
131
1032
|
}
|
|
@@ -136,7 +1037,8 @@ export interface PutObjectLegalHoldRequest {
|
|
|
136
1037
|
/**
|
|
137
1038
|
* @public
|
|
138
1039
|
* <p>The bucket name containing the object that you want to place a legal hold on. </p>
|
|
139
|
-
* <p>
|
|
1040
|
+
* <p>
|
|
1041
|
+
* <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>
|
|
140
1042
|
* <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.
|
|
141
1043
|
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
142
1044
|
*/
|
|
@@ -156,10 +1058,13 @@ export interface PutObjectLegalHoldRequest {
|
|
|
156
1058
|
* @public
|
|
157
1059
|
* <p>Confirms that the requester knows that they will be charged for the request. Bucket
|
|
158
1060
|
* owners need not specify this parameter in their requests. If either the source or
|
|
159
|
-
* destination
|
|
1061
|
+
* destination S3 bucket has Requester Pays enabled, the requester will pay for
|
|
160
1062
|
* corresponding charges to copy the object. For information about downloading objects from
|
|
161
1063
|
* Requester Pays buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in
|
|
162
1064
|
* Requester Pays Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1065
|
+
* <note>
|
|
1066
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
1067
|
+
* </note>
|
|
163
1068
|
*/
|
|
164
1069
|
RequestPayer?: RequestPayer;
|
|
165
1070
|
/**
|
|
@@ -175,8 +1080,8 @@ export interface PutObjectLegalHoldRequest {
|
|
|
175
1080
|
ContentMD5?: string;
|
|
176
1081
|
/**
|
|
177
1082
|
* @public
|
|
178
|
-
* <p>Indicates the algorithm used to create the checksum for the object when
|
|
179
|
-
* additional functionality if
|
|
1083
|
+
* <p>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any
|
|
1084
|
+
* 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
|
|
180
1085
|
* <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
|
|
181
1086
|
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
|
|
182
1087
|
* the <i>Amazon S3 User Guide</i>.</p>
|
|
@@ -186,7 +1091,7 @@ export interface PutObjectLegalHoldRequest {
|
|
|
186
1091
|
ChecksumAlgorithm?: ChecksumAlgorithm;
|
|
187
1092
|
/**
|
|
188
1093
|
* @public
|
|
189
|
-
* <p>The account ID of the expected bucket owner. If the
|
|
1094
|
+
* <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>
|
|
190
1095
|
*/
|
|
191
1096
|
ExpectedBucketOwner?: string;
|
|
192
1097
|
}
|
|
@@ -198,6 +1103,9 @@ export interface PutObjectLockConfigurationOutput {
|
|
|
198
1103
|
* @public
|
|
199
1104
|
* <p>If present, indicates that the requester was successfully charged for the
|
|
200
1105
|
* request.</p>
|
|
1106
|
+
* <note>
|
|
1107
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
1108
|
+
* </note>
|
|
201
1109
|
*/
|
|
202
1110
|
RequestCharged?: RequestCharged;
|
|
203
1111
|
}
|
|
@@ -221,10 +1129,13 @@ export interface PutObjectLockConfigurationRequest {
|
|
|
221
1129
|
* @public
|
|
222
1130
|
* <p>Confirms that the requester knows that they will be charged for the request. Bucket
|
|
223
1131
|
* owners need not specify this parameter in their requests. If either the source or
|
|
224
|
-
* destination
|
|
1132
|
+
* destination S3 bucket has Requester Pays enabled, the requester will pay for
|
|
225
1133
|
* corresponding charges to copy the object. For information about downloading objects from
|
|
226
1134
|
* Requester Pays buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in
|
|
227
1135
|
* Requester Pays Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1136
|
+
* <note>
|
|
1137
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
1138
|
+
* </note>
|
|
228
1139
|
*/
|
|
229
1140
|
RequestPayer?: RequestPayer;
|
|
230
1141
|
/**
|
|
@@ -240,8 +1151,8 @@ export interface PutObjectLockConfigurationRequest {
|
|
|
240
1151
|
ContentMD5?: string;
|
|
241
1152
|
/**
|
|
242
1153
|
* @public
|
|
243
|
-
* <p>Indicates the algorithm used to create the checksum for the object when
|
|
244
|
-
* additional functionality if
|
|
1154
|
+
* <p>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any
|
|
1155
|
+
* 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
|
|
245
1156
|
* <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
|
|
246
1157
|
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
|
|
247
1158
|
* the <i>Amazon S3 User Guide</i>.</p>
|
|
@@ -251,7 +1162,7 @@ export interface PutObjectLockConfigurationRequest {
|
|
|
251
1162
|
ChecksumAlgorithm?: ChecksumAlgorithm;
|
|
252
1163
|
/**
|
|
253
1164
|
* @public
|
|
254
|
-
* <p>The account ID of the expected bucket owner. If the
|
|
1165
|
+
* <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>
|
|
255
1166
|
*/
|
|
256
1167
|
ExpectedBucketOwner?: string;
|
|
257
1168
|
}
|
|
@@ -263,6 +1174,9 @@ export interface PutObjectRetentionOutput {
|
|
|
263
1174
|
* @public
|
|
264
1175
|
* <p>If present, indicates that the requester was successfully charged for the
|
|
265
1176
|
* request.</p>
|
|
1177
|
+
* <note>
|
|
1178
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
1179
|
+
* </note>
|
|
266
1180
|
*/
|
|
267
1181
|
RequestCharged?: RequestCharged;
|
|
268
1182
|
}
|
|
@@ -274,7 +1188,8 @@ export interface PutObjectRetentionRequest {
|
|
|
274
1188
|
* @public
|
|
275
1189
|
* <p>The bucket name that contains the object you want to apply this Object Retention
|
|
276
1190
|
* configuration to. </p>
|
|
277
|
-
* <p>
|
|
1191
|
+
* <p>
|
|
1192
|
+
* <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>
|
|
278
1193
|
* <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.
|
|
279
1194
|
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
280
1195
|
*/
|
|
@@ -294,10 +1209,13 @@ export interface PutObjectRetentionRequest {
|
|
|
294
1209
|
* @public
|
|
295
1210
|
* <p>Confirms that the requester knows that they will be charged for the request. Bucket
|
|
296
1211
|
* owners need not specify this parameter in their requests. If either the source or
|
|
297
|
-
* destination
|
|
1212
|
+
* destination S3 bucket has Requester Pays enabled, the requester will pay for
|
|
298
1213
|
* corresponding charges to copy the object. For information about downloading objects from
|
|
299
1214
|
* Requester Pays buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in
|
|
300
1215
|
* Requester Pays Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1216
|
+
* <note>
|
|
1217
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
1218
|
+
* </note>
|
|
301
1219
|
*/
|
|
302
1220
|
RequestPayer?: RequestPayer;
|
|
303
1221
|
/**
|
|
@@ -319,8 +1237,8 @@ export interface PutObjectRetentionRequest {
|
|
|
319
1237
|
ContentMD5?: string;
|
|
320
1238
|
/**
|
|
321
1239
|
* @public
|
|
322
|
-
* <p>Indicates the algorithm used to create the checksum for the object when
|
|
323
|
-
* additional functionality if
|
|
1240
|
+
* <p>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any
|
|
1241
|
+
* 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
|
|
324
1242
|
* <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
|
|
325
1243
|
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
|
|
326
1244
|
* the <i>Amazon S3 User Guide</i>.</p>
|
|
@@ -330,7 +1248,7 @@ export interface PutObjectRetentionRequest {
|
|
|
330
1248
|
ChecksumAlgorithm?: ChecksumAlgorithm;
|
|
331
1249
|
/**
|
|
332
1250
|
* @public
|
|
333
|
-
* <p>The account ID of the expected bucket owner. If the
|
|
1251
|
+
* <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>
|
|
334
1252
|
*/
|
|
335
1253
|
ExpectedBucketOwner?: string;
|
|
336
1254
|
}
|
|
@@ -351,8 +1269,10 @@ export interface PutObjectTaggingRequest {
|
|
|
351
1269
|
/**
|
|
352
1270
|
* @public
|
|
353
1271
|
* <p>The bucket name containing the object. </p>
|
|
354
|
-
* <p>
|
|
355
|
-
*
|
|
1272
|
+
* <p>
|
|
1273
|
+
* <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>
|
|
1274
|
+
* <p>
|
|
1275
|
+
* <b>S3 on Outposts</b> - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code>
|
|
356
1276
|
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
357
1277
|
* <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.
|
|
358
1278
|
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
@@ -376,8 +1296,8 @@ export interface PutObjectTaggingRequest {
|
|
|
376
1296
|
ContentMD5?: string;
|
|
377
1297
|
/**
|
|
378
1298
|
* @public
|
|
379
|
-
* <p>Indicates the algorithm used to create the checksum for the object when
|
|
380
|
-
* additional functionality if
|
|
1299
|
+
* <p>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any
|
|
1300
|
+
* 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
|
|
381
1301
|
* <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
|
|
382
1302
|
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
|
|
383
1303
|
* the <i>Amazon S3 User Guide</i>.</p>
|
|
@@ -392,17 +1312,20 @@ export interface PutObjectTaggingRequest {
|
|
|
392
1312
|
Tagging: Tagging | undefined;
|
|
393
1313
|
/**
|
|
394
1314
|
* @public
|
|
395
|
-
* <p>The account ID of the expected bucket owner. If the
|
|
1315
|
+
* <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
|
|
396
1316
|
*/
|
|
397
1317
|
ExpectedBucketOwner?: string;
|
|
398
1318
|
/**
|
|
399
1319
|
* @public
|
|
400
1320
|
* <p>Confirms that the requester knows that they will be charged for the request. Bucket
|
|
401
1321
|
* owners need not specify this parameter in their requests. If either the source or
|
|
402
|
-
* destination
|
|
1322
|
+
* destination S3 bucket has Requester Pays enabled, the requester will pay for
|
|
403
1323
|
* corresponding charges to copy the object. For information about downloading objects from
|
|
404
1324
|
* Requester Pays buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in
|
|
405
1325
|
* Requester Pays Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1326
|
+
* <note>
|
|
1327
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
1328
|
+
* </note>
|
|
406
1329
|
*/
|
|
407
1330
|
RequestPayer?: RequestPayer;
|
|
408
1331
|
}
|
|
@@ -426,8 +1349,8 @@ export interface PutPublicAccessBlockRequest {
|
|
|
426
1349
|
ContentMD5?: string;
|
|
427
1350
|
/**
|
|
428
1351
|
* @public
|
|
429
|
-
* <p>Indicates the algorithm used to create the checksum for the object when
|
|
430
|
-
* additional functionality if
|
|
1352
|
+
* <p>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any
|
|
1353
|
+
* 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
|
|
431
1354
|
* <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
|
|
432
1355
|
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
|
|
433
1356
|
* the <i>Amazon S3 User Guide</i>.</p>
|
|
@@ -444,7 +1367,7 @@ export interface PutPublicAccessBlockRequest {
|
|
|
444
1367
|
PublicAccessBlockConfiguration: PublicAccessBlockConfiguration | undefined;
|
|
445
1368
|
/**
|
|
446
1369
|
* @public
|
|
447
|
-
* <p>The account ID of the expected bucket owner. If the
|
|
1370
|
+
* <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>
|
|
448
1371
|
*/
|
|
449
1372
|
ExpectedBucketOwner?: string;
|
|
450
1373
|
}
|
|
@@ -468,6 +1391,9 @@ export interface RestoreObjectOutput {
|
|
|
468
1391
|
* @public
|
|
469
1392
|
* <p>If present, indicates that the requester was successfully charged for the
|
|
470
1393
|
* request.</p>
|
|
1394
|
+
* <note>
|
|
1395
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
1396
|
+
* </note>
|
|
471
1397
|
*/
|
|
472
1398
|
RequestCharged?: RequestCharged;
|
|
473
1399
|
/**
|
|
@@ -945,8 +1871,10 @@ export interface RestoreObjectRequest {
|
|
|
945
1871
|
/**
|
|
946
1872
|
* @public
|
|
947
1873
|
* <p>The bucket name containing the object to restore. </p>
|
|
948
|
-
* <p>
|
|
949
|
-
*
|
|
1874
|
+
* <p>
|
|
1875
|
+
* <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>
|
|
1876
|
+
* <p>
|
|
1877
|
+
* <b>S3 on Outposts</b> - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code>
|
|
950
1878
|
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
951
1879
|
* <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.
|
|
952
1880
|
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
@@ -971,16 +1899,19 @@ export interface RestoreObjectRequest {
|
|
|
971
1899
|
* @public
|
|
972
1900
|
* <p>Confirms that the requester knows that they will be charged for the request. Bucket
|
|
973
1901
|
* owners need not specify this parameter in their requests. If either the source or
|
|
974
|
-
* destination
|
|
1902
|
+
* destination S3 bucket has Requester Pays enabled, the requester will pay for
|
|
975
1903
|
* corresponding charges to copy the object. For information about downloading objects from
|
|
976
1904
|
* Requester Pays buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in
|
|
977
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>
|
|
978
1909
|
*/
|
|
979
1910
|
RequestPayer?: RequestPayer;
|
|
980
1911
|
/**
|
|
981
1912
|
* @public
|
|
982
|
-
* <p>Indicates the algorithm used to create the checksum for the object when
|
|
983
|
-
* additional functionality if
|
|
1913
|
+
* <p>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any
|
|
1914
|
+
* 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
|
|
984
1915
|
* <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
|
|
985
1916
|
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
|
|
986
1917
|
* the <i>Amazon S3 User Guide</i>.</p>
|
|
@@ -990,7 +1921,7 @@ export interface RestoreObjectRequest {
|
|
|
990
1921
|
ChecksumAlgorithm?: ChecksumAlgorithm;
|
|
991
1922
|
/**
|
|
992
1923
|
* @public
|
|
993
|
-
* <p>The account ID of the expected bucket owner. If the
|
|
1924
|
+
* <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>
|
|
994
1925
|
*/
|
|
995
1926
|
ExpectedBucketOwner?: string;
|
|
996
1927
|
}
|
|
@@ -1325,7 +2256,7 @@ export interface SelectObjectContentRequest {
|
|
|
1325
2256
|
ScanRange?: ScanRange;
|
|
1326
2257
|
/**
|
|
1327
2258
|
* @public
|
|
1328
|
-
* <p>The account ID of the expected bucket owner. If the
|
|
2259
|
+
* <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>
|
|
1329
2260
|
*/
|
|
1330
2261
|
ExpectedBucketOwner?: string;
|
|
1331
2262
|
}
|
|
@@ -1335,8 +2266,11 @@ export interface SelectObjectContentRequest {
|
|
|
1335
2266
|
export interface UploadPartOutput {
|
|
1336
2267
|
/**
|
|
1337
2268
|
* @public
|
|
1338
|
-
* <p>The server-side encryption algorithm used when
|
|
2269
|
+
* <p>The server-side encryption algorithm used when you store this object in Amazon S3 (for example,
|
|
1339
2270
|
* <code>AES256</code>, <code>aws:kms</code>).</p>
|
|
2271
|
+
* <note>
|
|
2272
|
+
* <p>For directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) (<code>AES256</code>) is supported.</p>
|
|
2273
|
+
* </note>
|
|
1340
2274
|
*/
|
|
1341
2275
|
ServerSideEncryption?: ServerSideEncryption;
|
|
1342
2276
|
/**
|
|
@@ -1347,7 +2281,7 @@ export interface UploadPartOutput {
|
|
|
1347
2281
|
/**
|
|
1348
2282
|
* @public
|
|
1349
2283
|
* <p>The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded
|
|
1350
|
-
* with the object.
|
|
2284
|
+
* 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
|
|
1351
2285
|
* with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums">
|
|
1352
2286
|
* Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1353
2287
|
*/
|
|
@@ -1355,7 +2289,7 @@ export interface UploadPartOutput {
|
|
|
1355
2289
|
/**
|
|
1356
2290
|
* @public
|
|
1357
2291
|
* <p>The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded
|
|
1358
|
-
* with the object.
|
|
2292
|
+
* 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
|
|
1359
2293
|
* with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums">
|
|
1360
2294
|
* Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1361
2295
|
*/
|
|
@@ -1363,7 +2297,7 @@ export interface UploadPartOutput {
|
|
|
1363
2297
|
/**
|
|
1364
2298
|
* @public
|
|
1365
2299
|
* <p>The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded
|
|
1366
|
-
* with the object.
|
|
2300
|
+
* 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
|
|
1367
2301
|
* with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums">
|
|
1368
2302
|
* Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1369
2303
|
*/
|
|
@@ -1371,7 +2305,7 @@ export interface UploadPartOutput {
|
|
|
1371
2305
|
/**
|
|
1372
2306
|
* @public
|
|
1373
2307
|
* <p>The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded
|
|
1374
|
-
* with the object.
|
|
2308
|
+
* 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
|
|
1375
2309
|
* with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums">
|
|
1376
2310
|
* Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1377
2311
|
*/
|
|
@@ -1379,32 +2313,47 @@ export interface UploadPartOutput {
|
|
|
1379
2313
|
/**
|
|
1380
2314
|
* @public
|
|
1381
2315
|
* <p>If server-side encryption with a customer-provided encryption key was requested, the
|
|
1382
|
-
* response will include this header
|
|
2316
|
+
* response will include this header to confirm the encryption algorithm that's used.</p>
|
|
2317
|
+
* <note>
|
|
2318
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
2319
|
+
* </note>
|
|
1383
2320
|
*/
|
|
1384
2321
|
SSECustomerAlgorithm?: string;
|
|
1385
2322
|
/**
|
|
1386
2323
|
* @public
|
|
1387
2324
|
* <p>If server-side encryption with a customer-provided encryption key was requested, the
|
|
1388
|
-
* response will include this header to provide round-trip message integrity verification of
|
|
2325
|
+
* response will include this header to provide the round-trip message integrity verification of
|
|
1389
2326
|
* the customer-provided encryption key.</p>
|
|
2327
|
+
* <note>
|
|
2328
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
2329
|
+
* </note>
|
|
1390
2330
|
*/
|
|
1391
2331
|
SSECustomerKeyMD5?: string;
|
|
1392
2332
|
/**
|
|
1393
2333
|
* @public
|
|
1394
|
-
* <p>If present,
|
|
1395
|
-
* was used for the object.</p>
|
|
2334
|
+
* <p>If present, indicates the ID of the Key Management Service (KMS) symmetric encryption customer managed key
|
|
2335
|
+
* that was used for the object.</p>
|
|
2336
|
+
* <note>
|
|
2337
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
2338
|
+
* </note>
|
|
1396
2339
|
*/
|
|
1397
2340
|
SSEKMSKeyId?: string;
|
|
1398
2341
|
/**
|
|
1399
2342
|
* @public
|
|
1400
2343
|
* <p>Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption
|
|
1401
2344
|
* with Key Management Service (KMS) keys (SSE-KMS).</p>
|
|
2345
|
+
* <note>
|
|
2346
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
2347
|
+
* </note>
|
|
1402
2348
|
*/
|
|
1403
2349
|
BucketKeyEnabled?: boolean;
|
|
1404
2350
|
/**
|
|
1405
2351
|
* @public
|
|
1406
2352
|
* <p>If present, indicates that the requester was successfully charged for the
|
|
1407
2353
|
* request.</p>
|
|
2354
|
+
* <note>
|
|
2355
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
2356
|
+
* </note>
|
|
1408
2357
|
*/
|
|
1409
2358
|
RequestCharged?: RequestCharged;
|
|
1410
2359
|
}
|
|
@@ -1420,8 +2369,20 @@ export interface UploadPartRequest {
|
|
|
1420
2369
|
/**
|
|
1421
2370
|
* @public
|
|
1422
2371
|
* <p>The name of the bucket to which the multipart upload was initiated.</p>
|
|
1423
|
-
* <p>
|
|
1424
|
-
*
|
|
2372
|
+
* <p>
|
|
2373
|
+
* <b>Directory buckets</b> - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code>
|
|
2374
|
+
* <i>Bucket_name</i>.s3express-<i>az_id</i>.<i>region</i>.amazonaws.com</code>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format <code>
|
|
2375
|
+
* <i>bucket_base_name</i>--<i>az-id</i>--x-s3</code> (for example, <code>
|
|
2376
|
+
* <i>DOC-EXAMPLE-BUCKET</i>--<i>usw2-az2</i>--x-s3</code>). For information about bucket naming
|
|
2377
|
+
* restrictions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html">Directory bucket naming
|
|
2378
|
+
* rules</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
2379
|
+
* <p>
|
|
2380
|
+
* <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>
|
|
2381
|
+
* <note>
|
|
2382
|
+
* <p>Access points and Object Lambda access points are not supported by directory buckets.</p>
|
|
2383
|
+
* </note>
|
|
2384
|
+
* <p>
|
|
2385
|
+
* <b>S3 on Outposts</b> - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code>
|
|
1425
2386
|
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1426
2387
|
* <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.
|
|
1427
2388
|
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
@@ -1438,12 +2399,15 @@ export interface UploadPartRequest {
|
|
|
1438
2399
|
* <p>The base64-encoded 128-bit MD5 digest of the part data. This parameter is auto-populated
|
|
1439
2400
|
* when using the command from the CLI. This parameter is required if object lock parameters
|
|
1440
2401
|
* are specified.</p>
|
|
2402
|
+
* <note>
|
|
2403
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
2404
|
+
* </note>
|
|
1441
2405
|
*/
|
|
1442
2406
|
ContentMD5?: string;
|
|
1443
2407
|
/**
|
|
1444
2408
|
* @public
|
|
1445
|
-
* <p>Indicates the algorithm used to create the checksum for the object when
|
|
1446
|
-
* additional functionality if
|
|
2409
|
+
* <p>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any
|
|
2410
|
+
* 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
|
|
1447
2411
|
* <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
|
|
1448
2412
|
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
|
|
1449
2413
|
* the <i>Amazon S3 User Guide</i>.</p>
|
|
@@ -1503,8 +2467,11 @@ export interface UploadPartRequest {
|
|
|
1503
2467
|
UploadId: string | undefined;
|
|
1504
2468
|
/**
|
|
1505
2469
|
* @public
|
|
1506
|
-
* <p>Specifies the algorithm to use
|
|
2470
|
+
* <p>Specifies the algorithm to use when encrypting the object (for example,
|
|
1507
2471
|
* AES256).</p>
|
|
2472
|
+
* <note>
|
|
2473
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
2474
|
+
* </note>
|
|
1508
2475
|
*/
|
|
1509
2476
|
SSECustomerAlgorithm?: string;
|
|
1510
2477
|
/**
|
|
@@ -1514,6 +2481,9 @@ export interface UploadPartRequest {
|
|
|
1514
2481
|
* encryption key. The key must be appropriate for use with the algorithm specified in the
|
|
1515
2482
|
* <code>x-amz-server-side-encryption-customer-algorithm header</code>. This must be the
|
|
1516
2483
|
* same encryption key specified in the initiate multipart upload request.</p>
|
|
2484
|
+
* <note>
|
|
2485
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
2486
|
+
* </note>
|
|
1517
2487
|
*/
|
|
1518
2488
|
SSECustomerKey?: string;
|
|
1519
2489
|
/**
|
|
@@ -1521,21 +2491,27 @@ export interface UploadPartRequest {
|
|
|
1521
2491
|
* <p>Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses
|
|
1522
2492
|
* this header for a message integrity check to ensure that the encryption key was transmitted
|
|
1523
2493
|
* without error.</p>
|
|
2494
|
+
* <note>
|
|
2495
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
2496
|
+
* </note>
|
|
1524
2497
|
*/
|
|
1525
2498
|
SSECustomerKeyMD5?: string;
|
|
1526
2499
|
/**
|
|
1527
2500
|
* @public
|
|
1528
2501
|
* <p>Confirms that the requester knows that they will be charged for the request. Bucket
|
|
1529
2502
|
* owners need not specify this parameter in their requests. If either the source or
|
|
1530
|
-
* destination
|
|
2503
|
+
* destination S3 bucket has Requester Pays enabled, the requester will pay for
|
|
1531
2504
|
* corresponding charges to copy the object. For information about downloading objects from
|
|
1532
2505
|
* Requester Pays buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in
|
|
1533
2506
|
* Requester Pays Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
2507
|
+
* <note>
|
|
2508
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
2509
|
+
* </note>
|
|
1534
2510
|
*/
|
|
1535
2511
|
RequestPayer?: RequestPayer;
|
|
1536
2512
|
/**
|
|
1537
2513
|
* @public
|
|
1538
|
-
* <p>The account ID of the expected bucket owner. If the
|
|
2514
|
+
* <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>
|
|
1539
2515
|
*/
|
|
1540
2516
|
ExpectedBucketOwner?: string;
|
|
1541
2517
|
}
|
|
@@ -1557,7 +2533,7 @@ export interface CopyPartResult {
|
|
|
1557
2533
|
/**
|
|
1558
2534
|
* @public
|
|
1559
2535
|
* <p>The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded
|
|
1560
|
-
* with the object.
|
|
2536
|
+
* 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
|
|
1561
2537
|
* with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums">
|
|
1562
2538
|
* Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1563
2539
|
*/
|
|
@@ -1565,7 +2541,7 @@ export interface CopyPartResult {
|
|
|
1565
2541
|
/**
|
|
1566
2542
|
* @public
|
|
1567
2543
|
* <p>The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded
|
|
1568
|
-
* with the object.
|
|
2544
|
+
* 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
|
|
1569
2545
|
* with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums">
|
|
1570
2546
|
* Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1571
2547
|
*/
|
|
@@ -1573,7 +2549,7 @@ export interface CopyPartResult {
|
|
|
1573
2549
|
/**
|
|
1574
2550
|
* @public
|
|
1575
2551
|
* <p>The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded
|
|
1576
|
-
* with the object.
|
|
2552
|
+
* 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
|
|
1577
2553
|
* with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums">
|
|
1578
2554
|
* Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1579
2555
|
*/
|
|
@@ -1581,7 +2557,7 @@ export interface CopyPartResult {
|
|
|
1581
2557
|
/**
|
|
1582
2558
|
* @public
|
|
1583
2559
|
* <p>The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded
|
|
1584
|
-
* with the object.
|
|
2560
|
+
* 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
|
|
1585
2561
|
* with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums">
|
|
1586
2562
|
* Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1587
2563
|
*/
|
|
@@ -1595,6 +2571,9 @@ export interface UploadPartCopyOutput {
|
|
|
1595
2571
|
* @public
|
|
1596
2572
|
* <p>The version of the source object that was copied, if you have enabled versioning on the
|
|
1597
2573
|
* source bucket.</p>
|
|
2574
|
+
* <note>
|
|
2575
|
+
* <p>This functionality is not supported when the source object is in a directory bucket.</p>
|
|
2576
|
+
* </note>
|
|
1598
2577
|
*/
|
|
1599
2578
|
CopySourceVersionId?: string;
|
|
1600
2579
|
/**
|
|
@@ -1604,39 +2583,57 @@ export interface UploadPartCopyOutput {
|
|
|
1604
2583
|
CopyPartResult?: CopyPartResult;
|
|
1605
2584
|
/**
|
|
1606
2585
|
* @public
|
|
1607
|
-
* <p>The server-side encryption algorithm used when
|
|
2586
|
+
* <p>The server-side encryption algorithm used when you store this object in Amazon S3 (for example,
|
|
1608
2587
|
* <code>AES256</code>, <code>aws:kms</code>).</p>
|
|
2588
|
+
* <note>
|
|
2589
|
+
* <p>For directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) (<code>AES256</code>) is supported.</p>
|
|
2590
|
+
* </note>
|
|
1609
2591
|
*/
|
|
1610
2592
|
ServerSideEncryption?: ServerSideEncryption;
|
|
1611
2593
|
/**
|
|
1612
2594
|
* @public
|
|
1613
2595
|
* <p>If server-side encryption with a customer-provided encryption key was requested, the
|
|
1614
|
-
* response will include this header
|
|
2596
|
+
* response will include this header to confirm the encryption algorithm that's used.</p>
|
|
2597
|
+
* <note>
|
|
2598
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
2599
|
+
* </note>
|
|
1615
2600
|
*/
|
|
1616
2601
|
SSECustomerAlgorithm?: string;
|
|
1617
2602
|
/**
|
|
1618
2603
|
* @public
|
|
1619
2604
|
* <p>If server-side encryption with a customer-provided encryption key was requested, the
|
|
1620
|
-
* response will include this header to provide round-trip message integrity verification of
|
|
2605
|
+
* response will include this header to provide the round-trip message integrity verification of
|
|
1621
2606
|
* the customer-provided encryption key.</p>
|
|
2607
|
+
* <note>
|
|
2608
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
2609
|
+
* </note>
|
|
1622
2610
|
*/
|
|
1623
2611
|
SSECustomerKeyMD5?: string;
|
|
1624
2612
|
/**
|
|
1625
2613
|
* @public
|
|
1626
|
-
* <p>If present,
|
|
2614
|
+
* <p>If present, indicates the ID of the Key Management Service (KMS) symmetric encryption customer managed key
|
|
1627
2615
|
* that was used for the object.</p>
|
|
2616
|
+
* <note>
|
|
2617
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
2618
|
+
* </note>
|
|
1628
2619
|
*/
|
|
1629
2620
|
SSEKMSKeyId?: string;
|
|
1630
2621
|
/**
|
|
1631
2622
|
* @public
|
|
1632
2623
|
* <p>Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption
|
|
1633
2624
|
* with Key Management Service (KMS) keys (SSE-KMS).</p>
|
|
2625
|
+
* <note>
|
|
2626
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
2627
|
+
* </note>
|
|
1634
2628
|
*/
|
|
1635
2629
|
BucketKeyEnabled?: boolean;
|
|
1636
2630
|
/**
|
|
1637
2631
|
* @public
|
|
1638
2632
|
* <p>If present, indicates that the requester was successfully charged for the
|
|
1639
2633
|
* request.</p>
|
|
2634
|
+
* <note>
|
|
2635
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
2636
|
+
* </note>
|
|
1640
2637
|
*/
|
|
1641
2638
|
RequestCharged?: RequestCharged;
|
|
1642
2639
|
}
|
|
@@ -1647,8 +2644,20 @@ export interface UploadPartCopyRequest {
|
|
|
1647
2644
|
/**
|
|
1648
2645
|
* @public
|
|
1649
2646
|
* <p>The bucket name.</p>
|
|
1650
|
-
* <p>
|
|
1651
|
-
*
|
|
2647
|
+
* <p>
|
|
2648
|
+
* <b>Directory buckets</b> - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code>
|
|
2649
|
+
* <i>Bucket_name</i>.s3express-<i>az_id</i>.<i>region</i>.amazonaws.com</code>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format <code>
|
|
2650
|
+
* <i>bucket_base_name</i>--<i>az-id</i>--x-s3</code> (for example, <code>
|
|
2651
|
+
* <i>DOC-EXAMPLE-BUCKET</i>--<i>usw2-az2</i>--x-s3</code>). For information about bucket naming
|
|
2652
|
+
* restrictions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html">Directory bucket naming
|
|
2653
|
+
* rules</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
2654
|
+
* <p>
|
|
2655
|
+
* <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>
|
|
2656
|
+
* <note>
|
|
2657
|
+
* <p>Access points and Object Lambda access points are not supported by directory buckets.</p>
|
|
2658
|
+
* </note>
|
|
2659
|
+
* <p>
|
|
2660
|
+
* <b>S3 on Outposts</b> - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code>
|
|
1652
2661
|
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1653
2662
|
* <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.
|
|
1654
2663
|
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
@@ -1669,36 +2678,103 @@ export interface UploadPartCopyRequest {
|
|
|
1669
2678
|
* <li>
|
|
1670
2679
|
* <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>
|
|
1671
2680
|
* <note>
|
|
1672
|
-
* <
|
|
2681
|
+
* <ul>
|
|
2682
|
+
* <li>
|
|
2683
|
+
* <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>
|
|
2684
|
+
* </li>
|
|
2685
|
+
* <li>
|
|
2686
|
+
* <p>Access points are not supported by directory buckets.</p>
|
|
2687
|
+
* </li>
|
|
2688
|
+
* </ul>
|
|
1673
2689
|
* </note>
|
|
1674
2690
|
* <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>
|
|
1675
2691
|
* </li>
|
|
1676
2692
|
* </ul>
|
|
1677
|
-
* <p>
|
|
1678
|
-
*
|
|
1679
|
-
*
|
|
1680
|
-
*
|
|
1681
|
-
*
|
|
2693
|
+
* <p>If your bucket has versioning enabled, you could have multiple versions of the
|
|
2694
|
+
* same object. By default, <code>x-amz-copy-source</code> identifies the current
|
|
2695
|
+
* version of the source object to copy.
|
|
2696
|
+
* To copy a specific version of the source object to copy, append <code>?versionId=<version-id></code>
|
|
2697
|
+
* to the <code>x-amz-copy-source</code> request header (for example,
|
|
2698
|
+
* <code>x-amz-copy-source: /awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893</code>).
|
|
2699
|
+
* </p>
|
|
2700
|
+
* <p>If the current version is a delete marker and you
|
|
2701
|
+
* don't specify a versionId in the <code>x-amz-copy-source</code> request header, Amazon S3 returns a
|
|
2702
|
+
* <code>404 Not Found</code> error, because the object does not exist. If you specify versionId in the
|
|
2703
|
+
* <code>x-amz-copy-source</code> and the versionId is a delete marker, Amazon S3
|
|
2704
|
+
* returns an HTTP <code>400 Bad Request</code> error, because you are not allowed to specify a delete marker
|
|
2705
|
+
* as a version for the <code>x-amz-copy-source</code>. </p>
|
|
2706
|
+
* <note>
|
|
2707
|
+
* <p>
|
|
2708
|
+
* <b>Directory buckets</b> - S3 Versioning isn't enabled and supported for directory buckets.</p>
|
|
2709
|
+
* </note>
|
|
1682
2710
|
*/
|
|
1683
2711
|
CopySource: string | undefined;
|
|
1684
2712
|
/**
|
|
1685
2713
|
* @public
|
|
1686
2714
|
* <p>Copies the object if its entity tag (ETag) matches the specified tag.</p>
|
|
2715
|
+
* <p>If both of the
|
|
2716
|
+
* <code>x-amz-copy-source-if-match</code> and
|
|
2717
|
+
* <code>x-amz-copy-source-if-unmodified-since</code> headers are present in the
|
|
2718
|
+
* request as follows:</p>
|
|
2719
|
+
* <p>
|
|
2720
|
+
* <code>x-amz-copy-source-if-match</code> condition evaluates to <code>true</code>,
|
|
2721
|
+
* and;</p>
|
|
2722
|
+
* <p>
|
|
2723
|
+
* <code>x-amz-copy-source-if-unmodified-since</code> condition evaluates to
|
|
2724
|
+
* <code>false</code>;</p>
|
|
2725
|
+
* <p>Amazon S3 returns <code>200 OK</code> and copies the data.
|
|
2726
|
+
* </p>
|
|
1687
2727
|
*/
|
|
1688
2728
|
CopySourceIfMatch?: string;
|
|
1689
2729
|
/**
|
|
1690
2730
|
* @public
|
|
1691
2731
|
* <p>Copies the object if it has been modified since the specified time.</p>
|
|
2732
|
+
* <p>If both of the
|
|
2733
|
+
* <code>x-amz-copy-source-if-none-match</code> and
|
|
2734
|
+
* <code>x-amz-copy-source-if-modified-since</code> headers are present in the
|
|
2735
|
+
* request as follows:</p>
|
|
2736
|
+
* <p>
|
|
2737
|
+
* <code>x-amz-copy-source-if-none-match</code> condition evaluates to
|
|
2738
|
+
* <code>false</code>, and;</p>
|
|
2739
|
+
* <p>
|
|
2740
|
+
* <code>x-amz-copy-source-if-modified-since</code> condition evaluates to
|
|
2741
|
+
* <code>true</code>;</p>
|
|
2742
|
+
* <p>Amazon S3 returns <code>412 Precondition Failed</code> response code.
|
|
2743
|
+
* </p>
|
|
1692
2744
|
*/
|
|
1693
2745
|
CopySourceIfModifiedSince?: Date;
|
|
1694
2746
|
/**
|
|
1695
2747
|
* @public
|
|
1696
2748
|
* <p>Copies the object if its entity tag (ETag) is different than the specified ETag.</p>
|
|
2749
|
+
* <p>If both of the
|
|
2750
|
+
* <code>x-amz-copy-source-if-none-match</code> and
|
|
2751
|
+
* <code>x-amz-copy-source-if-modified-since</code> headers are present in the
|
|
2752
|
+
* request as follows:</p>
|
|
2753
|
+
* <p>
|
|
2754
|
+
* <code>x-amz-copy-source-if-none-match</code> condition evaluates to
|
|
2755
|
+
* <code>false</code>, and;</p>
|
|
2756
|
+
* <p>
|
|
2757
|
+
* <code>x-amz-copy-source-if-modified-since</code> condition evaluates to
|
|
2758
|
+
* <code>true</code>;</p>
|
|
2759
|
+
* <p>Amazon S3 returns <code>412 Precondition Failed</code> response code.
|
|
2760
|
+
* </p>
|
|
1697
2761
|
*/
|
|
1698
2762
|
CopySourceIfNoneMatch?: string;
|
|
1699
2763
|
/**
|
|
1700
2764
|
* @public
|
|
1701
2765
|
* <p>Copies the object if it hasn't been modified since the specified time.</p>
|
|
2766
|
+
* <p>If both of the
|
|
2767
|
+
* <code>x-amz-copy-source-if-match</code> and
|
|
2768
|
+
* <code>x-amz-copy-source-if-unmodified-since</code> headers are present in the
|
|
2769
|
+
* request as follows:</p>
|
|
2770
|
+
* <p>
|
|
2771
|
+
* <code>x-amz-copy-source-if-match</code> condition evaluates to <code>true</code>,
|
|
2772
|
+
* and;</p>
|
|
2773
|
+
* <p>
|
|
2774
|
+
* <code>x-amz-copy-source-if-unmodified-since</code> condition evaluates to
|
|
2775
|
+
* <code>false</code>;</p>
|
|
2776
|
+
* <p>Amazon S3 returns <code>200 OK</code> and copies the data.
|
|
2777
|
+
* </p>
|
|
1702
2778
|
*/
|
|
1703
2779
|
CopySourceIfUnmodifiedSince?: Date;
|
|
1704
2780
|
/**
|
|
@@ -1727,8 +2803,11 @@ export interface UploadPartCopyRequest {
|
|
|
1727
2803
|
UploadId: string | undefined;
|
|
1728
2804
|
/**
|
|
1729
2805
|
* @public
|
|
1730
|
-
* <p>Specifies the algorithm to use
|
|
2806
|
+
* <p>Specifies the algorithm to use when encrypting the object (for example,
|
|
1731
2807
|
* AES256).</p>
|
|
2808
|
+
* <note>
|
|
2809
|
+
* <p>This functionality is not supported when the destination bucket is a directory bucket.</p>
|
|
2810
|
+
* </note>
|
|
1732
2811
|
*/
|
|
1733
2812
|
SSECustomerAlgorithm?: string;
|
|
1734
2813
|
/**
|
|
@@ -1738,6 +2817,9 @@ export interface UploadPartCopyRequest {
|
|
|
1738
2817
|
* encryption key. The key must be appropriate for use with the algorithm specified in the
|
|
1739
2818
|
* <code>x-amz-server-side-encryption-customer-algorithm</code> header. This must be the
|
|
1740
2819
|
* same encryption key specified in the initiate multipart upload request.</p>
|
|
2820
|
+
* <note>
|
|
2821
|
+
* <p>This functionality is not supported when the destination bucket is a directory bucket.</p>
|
|
2822
|
+
* </note>
|
|
1741
2823
|
*/
|
|
1742
2824
|
SSECustomerKey?: string;
|
|
1743
2825
|
/**
|
|
@@ -1745,12 +2827,18 @@ export interface UploadPartCopyRequest {
|
|
|
1745
2827
|
* <p>Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses
|
|
1746
2828
|
* this header for a message integrity check to ensure that the encryption key was transmitted
|
|
1747
2829
|
* without error.</p>
|
|
2830
|
+
* <note>
|
|
2831
|
+
* <p>This functionality is not supported when the destination bucket is a directory bucket.</p>
|
|
2832
|
+
* </note>
|
|
1748
2833
|
*/
|
|
1749
2834
|
SSECustomerKeyMD5?: string;
|
|
1750
2835
|
/**
|
|
1751
2836
|
* @public
|
|
1752
2837
|
* <p>Specifies the algorithm to use when decrypting the source object (for example,
|
|
1753
|
-
* AES256).</p>
|
|
2838
|
+
* <code>AES256</code>).</p>
|
|
2839
|
+
* <note>
|
|
2840
|
+
* <p>This functionality is not supported when the source object is in a directory bucket.</p>
|
|
2841
|
+
* </note>
|
|
1754
2842
|
*/
|
|
1755
2843
|
CopySourceSSECustomerAlgorithm?: string;
|
|
1756
2844
|
/**
|
|
@@ -1758,6 +2846,9 @@ export interface UploadPartCopyRequest {
|
|
|
1758
2846
|
* <p>Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source
|
|
1759
2847
|
* object. The encryption key provided in this header must be one that was used when the
|
|
1760
2848
|
* source object was created.</p>
|
|
2849
|
+
* <note>
|
|
2850
|
+
* <p>This functionality is not supported when the source object is in a directory bucket.</p>
|
|
2851
|
+
* </note>
|
|
1761
2852
|
*/
|
|
1762
2853
|
CopySourceSSECustomerKey?: string;
|
|
1763
2854
|
/**
|
|
@@ -1765,26 +2856,32 @@ export interface UploadPartCopyRequest {
|
|
|
1765
2856
|
* <p>Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses
|
|
1766
2857
|
* this header for a message integrity check to ensure that the encryption key was transmitted
|
|
1767
2858
|
* without error.</p>
|
|
2859
|
+
* <note>
|
|
2860
|
+
* <p>This functionality is not supported when the source object is in a directory bucket.</p>
|
|
2861
|
+
* </note>
|
|
1768
2862
|
*/
|
|
1769
2863
|
CopySourceSSECustomerKeyMD5?: string;
|
|
1770
2864
|
/**
|
|
1771
2865
|
* @public
|
|
1772
2866
|
* <p>Confirms that the requester knows that they will be charged for the request. Bucket
|
|
1773
2867
|
* owners need not specify this parameter in their requests. If either the source or
|
|
1774
|
-
* destination
|
|
2868
|
+
* destination S3 bucket has Requester Pays enabled, the requester will pay for
|
|
1775
2869
|
* corresponding charges to copy the object. For information about downloading objects from
|
|
1776
2870
|
* Requester Pays buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in
|
|
1777
2871
|
* Requester Pays Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
2872
|
+
* <note>
|
|
2873
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
2874
|
+
* </note>
|
|
1778
2875
|
*/
|
|
1779
2876
|
RequestPayer?: RequestPayer;
|
|
1780
2877
|
/**
|
|
1781
2878
|
* @public
|
|
1782
|
-
* <p>The account ID of the expected destination bucket owner. If the
|
|
2879
|
+
* <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>
|
|
1783
2880
|
*/
|
|
1784
2881
|
ExpectedBucketOwner?: string;
|
|
1785
2882
|
/**
|
|
1786
2883
|
* @public
|
|
1787
|
-
* <p>The account ID of the expected source bucket owner. If the
|
|
2884
|
+
* <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>
|
|
1788
2885
|
*/
|
|
1789
2886
|
ExpectedSourceBucketOwner?: string;
|
|
1790
2887
|
}
|
|
@@ -2072,6 +3169,9 @@ export interface WriteGetObjectResponseRequest {
|
|
|
2072
3169
|
* @public
|
|
2073
3170
|
* <p>If present, indicates that the requester was successfully charged for the
|
|
2074
3171
|
* request.</p>
|
|
3172
|
+
* <note>
|
|
3173
|
+
* <p>This functionality is not supported for directory buckets.</p>
|
|
3174
|
+
* </note>
|
|
2075
3175
|
*/
|
|
2076
3176
|
RequestCharged?: RequestCharged;
|
|
2077
3177
|
/**
|
|
@@ -2130,6 +3230,14 @@ export interface WriteGetObjectResponseRequest {
|
|
|
2130
3230
|
*/
|
|
2131
3231
|
BucketKeyEnabled?: boolean;
|
|
2132
3232
|
}
|
|
3233
|
+
/**
|
|
3234
|
+
* @internal
|
|
3235
|
+
*/
|
|
3236
|
+
export declare const PutObjectOutputFilterSensitiveLog: (obj: PutObjectOutput) => any;
|
|
3237
|
+
/**
|
|
3238
|
+
* @internal
|
|
3239
|
+
*/
|
|
3240
|
+
export declare const PutObjectRequestFilterSensitiveLog: (obj: PutObjectRequest) => any;
|
|
2133
3241
|
/**
|
|
2134
3242
|
* @internal
|
|
2135
3243
|
*/
|