@aws-sdk/client-s3 3.325.0 → 3.326.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.
Files changed (94) hide show
  1. package/dist-types/commands/AbortMultipartUploadCommand.d.ts +6 -0
  2. package/dist-types/commands/CompleteMultipartUploadCommand.d.ts +19 -0
  3. package/dist-types/commands/CopyObjectCommand.d.ts +23 -0
  4. package/dist-types/commands/CreateBucketCommand.d.ts +6 -0
  5. package/dist-types/commands/CreateMultipartUploadCommand.d.ts +18 -0
  6. package/dist-types/commands/DeleteBucketAnalyticsConfigurationCommand.d.ts +4 -0
  7. package/dist-types/commands/DeleteBucketCommand.d.ts +4 -0
  8. package/dist-types/commands/DeleteBucketCorsCommand.d.ts +4 -0
  9. package/dist-types/commands/DeleteBucketEncryptionCommand.d.ts +4 -0
  10. package/dist-types/commands/DeleteBucketIntelligentTieringConfigurationCommand.d.ts +4 -0
  11. package/dist-types/commands/DeleteBucketInventoryConfigurationCommand.d.ts +4 -0
  12. package/dist-types/commands/DeleteBucketLifecycleCommand.d.ts +4 -0
  13. package/dist-types/commands/DeleteBucketMetricsConfigurationCommand.d.ts +4 -0
  14. package/dist-types/commands/DeleteBucketOwnershipControlsCommand.d.ts +4 -0
  15. package/dist-types/commands/DeleteBucketPolicyCommand.d.ts +4 -0
  16. package/dist-types/commands/DeleteBucketReplicationCommand.d.ts +4 -0
  17. package/dist-types/commands/DeleteBucketTaggingCommand.d.ts +4 -0
  18. package/dist-types/commands/DeleteBucketWebsiteCommand.d.ts +4 -0
  19. package/dist-types/commands/DeleteObjectCommand.d.ts +18 -10
  20. package/dist-types/commands/DeleteObjectTaggingCommand.d.ts +17 -11
  21. package/dist-types/commands/DeleteObjectsCommand.d.ts +22 -0
  22. package/dist-types/commands/DeletePublicAccessBlockCommand.d.ts +4 -0
  23. package/dist-types/commands/GetBucketAccelerateConfigurationCommand.d.ts +6 -0
  24. package/dist-types/commands/GetBucketAclCommand.d.ts +21 -0
  25. package/dist-types/commands/GetBucketAnalyticsConfigurationCommand.d.ts +37 -0
  26. package/dist-types/commands/GetBucketCorsCommand.d.ts +23 -0
  27. package/dist-types/commands/GetBucketEncryptionCommand.d.ts +16 -0
  28. package/dist-types/commands/GetBucketIntelligentTieringConfigurationCommand.d.ts +31 -0
  29. package/dist-types/commands/GetBucketInventoryConfigurationCommand.d.ts +33 -0
  30. package/dist-types/commands/GetBucketLifecycleConfigurationCommand.d.ts +58 -0
  31. package/dist-types/commands/GetBucketLocationCommand.d.ts +6 -0
  32. package/dist-types/commands/GetBucketLoggingCommand.d.ts +21 -0
  33. package/dist-types/commands/GetBucketMetricsConfigurationCommand.d.ts +26 -0
  34. package/dist-types/commands/GetBucketNotificationConfigurationCommand.d.ts +63 -0
  35. package/dist-types/commands/GetBucketOwnershipControlsCommand.d.ts +12 -0
  36. package/dist-types/commands/GetBucketPolicyCommand.d.ts +6 -0
  37. package/dist-types/commands/GetBucketPolicyStatusCommand.d.ts +8 -0
  38. package/dist-types/commands/GetBucketReplicationCommand.d.ts +69 -0
  39. package/dist-types/commands/GetBucketRequestPaymentCommand.d.ts +6 -0
  40. package/dist-types/commands/GetBucketTaggingCommand.d.ts +11 -0
  41. package/dist-types/commands/GetBucketVersioningCommand.d.ts +7 -0
  42. package/dist-types/commands/GetBucketWebsiteCommand.d.ts +30 -0
  43. package/dist-types/commands/GetObjectAclCommand.d.ts +22 -0
  44. package/dist-types/commands/GetObjectAttributesCommand.d.ts +35 -0
  45. package/dist-types/commands/GetObjectCommand.d.ts +43 -0
  46. package/dist-types/commands/GetObjectLegalHoldCommand.d.ts +8 -0
  47. package/dist-types/commands/GetObjectLockConfigurationCommand.d.ts +15 -0
  48. package/dist-types/commands/GetObjectRetentionCommand.d.ts +9 -0
  49. package/dist-types/commands/GetObjectTaggingCommand.d.ts +12 -0
  50. package/dist-types/commands/GetObjectTorrentCommand.d.ts +7 -0
  51. package/dist-types/commands/GetPublicAccessBlockCommand.d.ts +11 -0
  52. package/dist-types/commands/HeadBucketCommand.d.ts +4 -0
  53. package/dist-types/commands/HeadObjectCommand.d.ts +41 -0
  54. package/dist-types/commands/ListBucketAnalyticsConfigurationsCommand.d.ts +42 -0
  55. package/dist-types/commands/ListBucketIntelligentTieringConfigurationsCommand.d.ts +36 -0
  56. package/dist-types/commands/ListBucketInventoryConfigurationsCommand.d.ts +38 -0
  57. package/dist-types/commands/ListBucketMetricsConfigurationsCommand.d.ts +31 -0
  58. package/dist-types/commands/ListBucketsCommand.d.ts +15 -31
  59. package/dist-types/commands/ListMultipartUploadsCommand.d.ts +37 -0
  60. package/dist-types/commands/ListObjectVersionsCommand.d.ts +50 -0
  61. package/dist-types/commands/ListObjectsCommand.d.ts +34 -0
  62. package/dist-types/commands/ListObjectsV2Command.d.ts +38 -2
  63. package/dist-types/commands/ListPartsCommand.d.ts +37 -0
  64. package/dist-types/commands/PutBucketAccelerateConfigurationCommand.d.ts +4 -0
  65. package/dist-types/commands/PutBucketAclCommand.d.ts +4 -0
  66. package/dist-types/commands/PutBucketAnalyticsConfigurationCommand.d.ts +4 -0
  67. package/dist-types/commands/PutBucketCorsCommand.d.ts +4 -0
  68. package/dist-types/commands/PutBucketEncryptionCommand.d.ts +4 -0
  69. package/dist-types/commands/PutBucketIntelligentTieringConfigurationCommand.d.ts +4 -0
  70. package/dist-types/commands/PutBucketInventoryConfigurationCommand.d.ts +4 -0
  71. package/dist-types/commands/PutBucketLifecycleConfigurationCommand.d.ts +4 -0
  72. package/dist-types/commands/PutBucketLoggingCommand.d.ts +4 -0
  73. package/dist-types/commands/PutBucketMetricsConfigurationCommand.d.ts +4 -0
  74. package/dist-types/commands/PutBucketNotificationConfigurationCommand.d.ts +4 -0
  75. package/dist-types/commands/PutBucketOwnershipControlsCommand.d.ts +4 -0
  76. package/dist-types/commands/PutBucketPolicyCommand.d.ts +4 -0
  77. package/dist-types/commands/PutBucketReplicationCommand.d.ts +4 -0
  78. package/dist-types/commands/PutBucketRequestPaymentCommand.d.ts +4 -0
  79. package/dist-types/commands/PutBucketTaggingCommand.d.ts +4 -0
  80. package/dist-types/commands/PutBucketVersioningCommand.d.ts +4 -0
  81. package/dist-types/commands/PutBucketWebsiteCommand.d.ts +4 -0
  82. package/dist-types/commands/PutObjectAclCommand.d.ts +6 -0
  83. package/dist-types/commands/PutObjectCommand.d.ts +68 -49
  84. package/dist-types/commands/PutObjectLegalHoldCommand.d.ts +6 -0
  85. package/dist-types/commands/PutObjectLockConfigurationCommand.d.ts +6 -0
  86. package/dist-types/commands/PutObjectRetentionCommand.d.ts +6 -0
  87. package/dist-types/commands/PutObjectTaggingCommand.d.ts +6 -0
  88. package/dist-types/commands/PutPublicAccessBlockCommand.d.ts +4 -0
  89. package/dist-types/commands/RestoreObjectCommand.d.ts +7 -0
  90. package/dist-types/commands/SelectObjectContentCommand.d.ts +26 -0
  91. package/dist-types/commands/UploadPartCommand.d.ts +16 -0
  92. package/dist-types/commands/UploadPartCopyCommand.d.ts +33 -13
  93. package/dist-types/commands/WriteGetObjectResponseCommand.d.ts +4 -0
  94. package/package.json +5 -5
@@ -61,6 +61,41 @@ export interface GetBucketAnalyticsConfigurationCommandOutput extends GetBucketA
61
61
  * };
62
62
  * const command = new GetBucketAnalyticsConfigurationCommand(input);
63
63
  * const response = await client.send(command);
64
+ * // { // GetBucketAnalyticsConfigurationOutput
65
+ * // AnalyticsConfiguration: { // AnalyticsConfiguration
66
+ * // Id: "STRING_VALUE", // required
67
+ * // Filter: { // AnalyticsFilter Union: only one key present
68
+ * // Prefix: "STRING_VALUE",
69
+ * // Tag: { // Tag
70
+ * // Key: "STRING_VALUE", // required
71
+ * // Value: "STRING_VALUE", // required
72
+ * // },
73
+ * // And: { // AnalyticsAndOperator
74
+ * // Prefix: "STRING_VALUE",
75
+ * // Tags: [ // TagSet
76
+ * // {
77
+ * // Key: "STRING_VALUE", // required
78
+ * // Value: "STRING_VALUE", // required
79
+ * // },
80
+ * // ],
81
+ * // },
82
+ * // },
83
+ * // StorageClassAnalysis: { // StorageClassAnalysis
84
+ * // DataExport: { // StorageClassAnalysisDataExport
85
+ * // OutputSchemaVersion: "V_1", // required
86
+ * // Destination: { // AnalyticsExportDestination
87
+ * // S3BucketDestination: { // AnalyticsS3BucketDestination
88
+ * // Format: "CSV", // required
89
+ * // BucketAccountId: "STRING_VALUE",
90
+ * // Bucket: "STRING_VALUE", // required
91
+ * // Prefix: "STRING_VALUE",
92
+ * // },
93
+ * // },
94
+ * // },
95
+ * // },
96
+ * // },
97
+ * // };
98
+ *
64
99
  * ```
65
100
  *
66
101
  * @param GetBucketAnalyticsConfigurationCommandInput - {@link GetBucketAnalyticsConfigurationCommandInput}
@@ -69,6 +104,8 @@ export interface GetBucketAnalyticsConfigurationCommandOutput extends GetBucketA
69
104
  * @see {@link GetBucketAnalyticsConfigurationCommandOutput} for command's `response` shape.
70
105
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
71
106
  *
107
+ * @throws {@link S3ServiceException}
108
+ * <p>Base exception class for all service exceptions from S3 service.</p>
72
109
  *
73
110
  */
74
111
  export declare class GetBucketAnalyticsConfigurationCommand extends $Command<GetBucketAnalyticsConfigurationCommandInput, GetBucketAnalyticsConfigurationCommandOutput, S3ClientResolvedConfig> {
@@ -51,6 +51,27 @@ export interface GetBucketCorsCommandOutput extends GetBucketCorsOutput, __Metad
51
51
  * };
52
52
  * const command = new GetBucketCorsCommand(input);
53
53
  * const response = await client.send(command);
54
+ * // { // GetBucketCorsOutput
55
+ * // CORSRules: [ // CORSRules
56
+ * // { // CORSRule
57
+ * // ID: "STRING_VALUE",
58
+ * // AllowedHeaders: [ // AllowedHeaders
59
+ * // "STRING_VALUE",
60
+ * // ],
61
+ * // AllowedMethods: [ // AllowedMethods // required
62
+ * // "STRING_VALUE",
63
+ * // ],
64
+ * // AllowedOrigins: [ // AllowedOrigins // required
65
+ * // "STRING_VALUE",
66
+ * // ],
67
+ * // ExposeHeaders: [ // ExposeHeaders
68
+ * // "STRING_VALUE",
69
+ * // ],
70
+ * // MaxAgeSeconds: Number("int"),
71
+ * // },
72
+ * // ],
73
+ * // };
74
+ *
54
75
  * ```
55
76
  *
56
77
  * @param GetBucketCorsCommandInput - {@link GetBucketCorsCommandInput}
@@ -59,6 +80,8 @@ export interface GetBucketCorsCommandOutput extends GetBucketCorsOutput, __Metad
59
80
  * @see {@link GetBucketCorsCommandOutput} for command's `response` shape.
60
81
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
61
82
  *
83
+ * @throws {@link S3ServiceException}
84
+ * <p>Base exception class for all service exceptions from S3 service.</p>
62
85
  *
63
86
  * @example To get cors configuration set on a bucket
64
87
  * ```javascript
@@ -53,6 +53,20 @@ export interface GetBucketEncryptionCommandOutput extends GetBucketEncryptionOut
53
53
  * };
54
54
  * const command = new GetBucketEncryptionCommand(input);
55
55
  * const response = await client.send(command);
56
+ * // { // GetBucketEncryptionOutput
57
+ * // ServerSideEncryptionConfiguration: { // ServerSideEncryptionConfiguration
58
+ * // Rules: [ // ServerSideEncryptionRules // required
59
+ * // { // ServerSideEncryptionRule
60
+ * // ApplyServerSideEncryptionByDefault: { // ServerSideEncryptionByDefault
61
+ * // SSEAlgorithm: "AES256" || "aws:kms", // required
62
+ * // KMSMasterKeyID: "STRING_VALUE",
63
+ * // },
64
+ * // BucketKeyEnabled: true || false,
65
+ * // },
66
+ * // ],
67
+ * // },
68
+ * // };
69
+ *
56
70
  * ```
57
71
  *
58
72
  * @param GetBucketEncryptionCommandInput - {@link GetBucketEncryptionCommandInput}
@@ -61,6 +75,8 @@ export interface GetBucketEncryptionCommandOutput extends GetBucketEncryptionOut
61
75
  * @see {@link GetBucketEncryptionCommandOutput} for command's `response` shape.
62
76
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
63
77
  *
78
+ * @throws {@link S3ServiceException}
79
+ * <p>Base exception class for all service exceptions from S3 service.</p>
64
80
  *
65
81
  */
66
82
  export declare class GetBucketEncryptionCommand extends $Command<GetBucketEncryptionCommandInput, GetBucketEncryptionCommandOutput, S3ClientResolvedConfig> {
@@ -54,6 +54,35 @@ export interface GetBucketIntelligentTieringConfigurationCommandOutput extends G
54
54
  * };
55
55
  * const command = new GetBucketIntelligentTieringConfigurationCommand(input);
56
56
  * const response = await client.send(command);
57
+ * // { // GetBucketIntelligentTieringConfigurationOutput
58
+ * // IntelligentTieringConfiguration: { // IntelligentTieringConfiguration
59
+ * // Id: "STRING_VALUE", // required
60
+ * // Filter: { // IntelligentTieringFilter
61
+ * // Prefix: "STRING_VALUE",
62
+ * // Tag: { // Tag
63
+ * // Key: "STRING_VALUE", // required
64
+ * // Value: "STRING_VALUE", // required
65
+ * // },
66
+ * // And: { // IntelligentTieringAndOperator
67
+ * // Prefix: "STRING_VALUE",
68
+ * // Tags: [ // TagSet
69
+ * // {
70
+ * // Key: "STRING_VALUE", // required
71
+ * // Value: "STRING_VALUE", // required
72
+ * // },
73
+ * // ],
74
+ * // },
75
+ * // },
76
+ * // Status: "Enabled" || "Disabled", // required
77
+ * // Tierings: [ // TieringList // required
78
+ * // { // Tiering
79
+ * // Days: Number("int"), // required
80
+ * // AccessTier: "ARCHIVE_ACCESS" || "DEEP_ARCHIVE_ACCESS", // required
81
+ * // },
82
+ * // ],
83
+ * // },
84
+ * // };
85
+ *
57
86
  * ```
58
87
  *
59
88
  * @param GetBucketIntelligentTieringConfigurationCommandInput - {@link GetBucketIntelligentTieringConfigurationCommandInput}
@@ -62,6 +91,8 @@ export interface GetBucketIntelligentTieringConfigurationCommandOutput extends G
62
91
  * @see {@link GetBucketIntelligentTieringConfigurationCommandOutput} for command's `response` shape.
63
92
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
64
93
  *
94
+ * @throws {@link S3ServiceException}
95
+ * <p>Base exception class for all service exceptions from S3 service.</p>
65
96
  *
66
97
  */
67
98
  export declare class GetBucketIntelligentTieringConfigurationCommand extends $Command<GetBucketIntelligentTieringConfigurationCommandInput, GetBucketIntelligentTieringConfigurationCommandOutput, S3ClientResolvedConfig> {
@@ -59,6 +59,37 @@ export interface GetBucketInventoryConfigurationCommandOutput extends GetBucketI
59
59
  * };
60
60
  * const command = new GetBucketInventoryConfigurationCommand(input);
61
61
  * const response = await client.send(command);
62
+ * // { // GetBucketInventoryConfigurationOutput
63
+ * // InventoryConfiguration: { // InventoryConfiguration
64
+ * // Destination: { // InventoryDestination
65
+ * // S3BucketDestination: { // InventoryS3BucketDestination
66
+ * // AccountId: "STRING_VALUE",
67
+ * // Bucket: "STRING_VALUE", // required
68
+ * // Format: "CSV" || "ORC" || "Parquet", // required
69
+ * // Prefix: "STRING_VALUE",
70
+ * // Encryption: { // InventoryEncryption
71
+ * // SSES3: {},
72
+ * // SSEKMS: { // SSEKMS
73
+ * // KeyId: "STRING_VALUE", // required
74
+ * // },
75
+ * // },
76
+ * // },
77
+ * // },
78
+ * // IsEnabled: true || false, // required
79
+ * // Filter: { // InventoryFilter
80
+ * // Prefix: "STRING_VALUE", // required
81
+ * // },
82
+ * // Id: "STRING_VALUE", // required
83
+ * // IncludedObjectVersions: "All" || "Current", // required
84
+ * // OptionalFields: [ // InventoryOptionalFields
85
+ * // "Size" || "LastModifiedDate" || "StorageClass" || "ETag" || "IsMultipartUploaded" || "ReplicationStatus" || "EncryptionStatus" || "ObjectLockRetainUntilDate" || "ObjectLockMode" || "ObjectLockLegalHoldStatus" || "IntelligentTieringAccessTier" || "BucketKeyStatus" || "ChecksumAlgorithm",
86
+ * // ],
87
+ * // Schedule: { // InventorySchedule
88
+ * // Frequency: "Daily" || "Weekly", // required
89
+ * // },
90
+ * // },
91
+ * // };
92
+ *
62
93
  * ```
63
94
  *
64
95
  * @param GetBucketInventoryConfigurationCommandInput - {@link GetBucketInventoryConfigurationCommandInput}
@@ -67,6 +98,8 @@ export interface GetBucketInventoryConfigurationCommandOutput extends GetBucketI
67
98
  * @see {@link GetBucketInventoryConfigurationCommandOutput} for command's `response` shape.
68
99
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
69
100
  *
101
+ * @throws {@link S3ServiceException}
102
+ * <p>Base exception class for all service exceptions from S3 service.</p>
70
103
  *
71
104
  */
72
105
  export declare class GetBucketInventoryConfigurationCommand extends $Command<GetBucketInventoryConfigurationCommandInput, GetBucketInventoryConfigurationCommandOutput, S3ClientResolvedConfig> {
@@ -85,6 +85,62 @@ export interface GetBucketLifecycleConfigurationCommandOutput extends GetBucketL
85
85
  * };
86
86
  * const command = new GetBucketLifecycleConfigurationCommand(input);
87
87
  * const response = await client.send(command);
88
+ * // { // GetBucketLifecycleConfigurationOutput
89
+ * // Rules: [ // LifecycleRules
90
+ * // { // LifecycleRule
91
+ * // Expiration: { // LifecycleExpiration
92
+ * // Date: new Date("TIMESTAMP"),
93
+ * // Days: Number("int"),
94
+ * // ExpiredObjectDeleteMarker: true || false,
95
+ * // },
96
+ * // ID: "STRING_VALUE",
97
+ * // Prefix: "STRING_VALUE",
98
+ * // Filter: { // LifecycleRuleFilter Union: only one key present
99
+ * // Prefix: "STRING_VALUE",
100
+ * // Tag: { // Tag
101
+ * // Key: "STRING_VALUE", // required
102
+ * // Value: "STRING_VALUE", // required
103
+ * // },
104
+ * // ObjectSizeGreaterThan: Number("long"),
105
+ * // ObjectSizeLessThan: Number("long"),
106
+ * // And: { // LifecycleRuleAndOperator
107
+ * // Prefix: "STRING_VALUE",
108
+ * // Tags: [ // TagSet
109
+ * // {
110
+ * // Key: "STRING_VALUE", // required
111
+ * // Value: "STRING_VALUE", // required
112
+ * // },
113
+ * // ],
114
+ * // ObjectSizeGreaterThan: Number("long"),
115
+ * // ObjectSizeLessThan: Number("long"),
116
+ * // },
117
+ * // },
118
+ * // Status: "Enabled" || "Disabled", // required
119
+ * // Transitions: [ // TransitionList
120
+ * // { // Transition
121
+ * // Date: new Date("TIMESTAMP"),
122
+ * // Days: Number("int"),
123
+ * // StorageClass: "GLACIER" || "STANDARD_IA" || "ONEZONE_IA" || "INTELLIGENT_TIERING" || "DEEP_ARCHIVE" || "GLACIER_IR",
124
+ * // },
125
+ * // ],
126
+ * // NoncurrentVersionTransitions: [ // NoncurrentVersionTransitionList
127
+ * // { // NoncurrentVersionTransition
128
+ * // NoncurrentDays: Number("int"),
129
+ * // StorageClass: "GLACIER" || "STANDARD_IA" || "ONEZONE_IA" || "INTELLIGENT_TIERING" || "DEEP_ARCHIVE" || "GLACIER_IR",
130
+ * // NewerNoncurrentVersions: Number("int"),
131
+ * // },
132
+ * // ],
133
+ * // NoncurrentVersionExpiration: { // NoncurrentVersionExpiration
134
+ * // NoncurrentDays: Number("int"),
135
+ * // NewerNoncurrentVersions: Number("int"),
136
+ * // },
137
+ * // AbortIncompleteMultipartUpload: { // AbortIncompleteMultipartUpload
138
+ * // DaysAfterInitiation: Number("int"),
139
+ * // },
140
+ * // },
141
+ * // ],
142
+ * // };
143
+ *
88
144
  * ```
89
145
  *
90
146
  * @param GetBucketLifecycleConfigurationCommandInput - {@link GetBucketLifecycleConfigurationCommandInput}
@@ -93,6 +149,8 @@ export interface GetBucketLifecycleConfigurationCommandOutput extends GetBucketL
93
149
  * @see {@link GetBucketLifecycleConfigurationCommandOutput} for command's `response` shape.
94
150
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
95
151
  *
152
+ * @throws {@link S3ServiceException}
153
+ * <p>Base exception class for all service exceptions from S3 service.</p>
96
154
  *
97
155
  * @example To get lifecycle configuration on a bucket
98
156
  * ```javascript
@@ -49,6 +49,10 @@ export interface GetBucketLocationCommandOutput extends GetBucketLocationOutput,
49
49
  * };
50
50
  * const command = new GetBucketLocationCommand(input);
51
51
  * const response = await client.send(command);
52
+ * // { // GetBucketLocationOutput
53
+ * // LocationConstraint: "af-south-1" || "ap-east-1" || "ap-northeast-1" || "ap-northeast-2" || "ap-northeast-3" || "ap-south-1" || "ap-southeast-1" || "ap-southeast-2" || "ap-southeast-3" || "ca-central-1" || "cn-north-1" || "cn-northwest-1" || "EU" || "eu-central-1" || "eu-north-1" || "eu-south-1" || "eu-west-1" || "eu-west-2" || "eu-west-3" || "me-south-1" || "sa-east-1" || "us-east-2" || "us-gov-east-1" || "us-gov-west-1" || "us-west-1" || "us-west-2",
54
+ * // };
55
+ *
52
56
  * ```
53
57
  *
54
58
  * @param GetBucketLocationCommandInput - {@link GetBucketLocationCommandInput}
@@ -57,6 +61,8 @@ export interface GetBucketLocationCommandOutput extends GetBucketLocationOutput,
57
61
  * @see {@link GetBucketLocationCommandOutput} for command's `response` shape.
58
62
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
59
63
  *
64
+ * @throws {@link S3ServiceException}
65
+ * <p>Base exception class for all service exceptions from S3 service.</p>
60
66
  *
61
67
  * @example To get bucket location
62
68
  * ```javascript
@@ -46,6 +46,25 @@ export interface GetBucketLoggingCommandOutput extends GetBucketLoggingOutput, _
46
46
  * };
47
47
  * const command = new GetBucketLoggingCommand(input);
48
48
  * const response = await client.send(command);
49
+ * // { // GetBucketLoggingOutput
50
+ * // LoggingEnabled: { // LoggingEnabled
51
+ * // TargetBucket: "STRING_VALUE", // required
52
+ * // TargetGrants: [ // TargetGrants
53
+ * // { // TargetGrant
54
+ * // Grantee: { // Grantee
55
+ * // DisplayName: "STRING_VALUE",
56
+ * // EmailAddress: "STRING_VALUE",
57
+ * // ID: "STRING_VALUE",
58
+ * // URI: "STRING_VALUE",
59
+ * // Type: "CanonicalUser" || "AmazonCustomerByEmail" || "Group", // required
60
+ * // },
61
+ * // Permission: "FULL_CONTROL" || "READ" || "WRITE",
62
+ * // },
63
+ * // ],
64
+ * // TargetPrefix: "STRING_VALUE", // required
65
+ * // },
66
+ * // };
67
+ *
49
68
  * ```
50
69
  *
51
70
  * @param GetBucketLoggingCommandInput - {@link GetBucketLoggingCommandInput}
@@ -54,6 +73,8 @@ export interface GetBucketLoggingCommandOutput extends GetBucketLoggingOutput, _
54
73
  * @see {@link GetBucketLoggingCommandOutput} for command's `response` shape.
55
74
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
56
75
  *
76
+ * @throws {@link S3ServiceException}
77
+ * <p>Base exception class for all service exceptions from S3 service.</p>
57
78
  *
58
79
  */
59
80
  export declare class GetBucketLoggingCommand extends $Command<GetBucketLoggingCommandInput, GetBucketLoggingCommandOutput, S3ClientResolvedConfig> {
@@ -66,6 +66,30 @@ export interface GetBucketMetricsConfigurationCommandOutput extends GetBucketMet
66
66
  * };
67
67
  * const command = new GetBucketMetricsConfigurationCommand(input);
68
68
  * const response = await client.send(command);
69
+ * // { // GetBucketMetricsConfigurationOutput
70
+ * // MetricsConfiguration: { // MetricsConfiguration
71
+ * // Id: "STRING_VALUE", // required
72
+ * // Filter: { // MetricsFilter Union: only one key present
73
+ * // Prefix: "STRING_VALUE",
74
+ * // Tag: { // Tag
75
+ * // Key: "STRING_VALUE", // required
76
+ * // Value: "STRING_VALUE", // required
77
+ * // },
78
+ * // AccessPointArn: "STRING_VALUE",
79
+ * // And: { // MetricsAndOperator
80
+ * // Prefix: "STRING_VALUE",
81
+ * // Tags: [ // TagSet
82
+ * // {
83
+ * // Key: "STRING_VALUE", // required
84
+ * // Value: "STRING_VALUE", // required
85
+ * // },
86
+ * // ],
87
+ * // AccessPointArn: "STRING_VALUE",
88
+ * // },
89
+ * // },
90
+ * // },
91
+ * // };
92
+ *
69
93
  * ```
70
94
  *
71
95
  * @param GetBucketMetricsConfigurationCommandInput - {@link GetBucketMetricsConfigurationCommandInput}
@@ -74,6 +98,8 @@ export interface GetBucketMetricsConfigurationCommandOutput extends GetBucketMet
74
98
  * @see {@link GetBucketMetricsConfigurationCommandOutput} for command's `response` shape.
75
99
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
76
100
  *
101
+ * @throws {@link S3ServiceException}
102
+ * <p>Base exception class for all service exceptions from S3 service.</p>
77
103
  *
78
104
  */
79
105
  export declare class GetBucketMetricsConfigurationCommand extends $Command<GetBucketMetricsConfigurationCommandInput, GetBucketMetricsConfigurationCommandOutput, S3ClientResolvedConfig> {
@@ -49,6 +49,67 @@ export interface GetBucketNotificationConfigurationCommandOutput extends Notific
49
49
  * };
50
50
  * const command = new GetBucketNotificationConfigurationCommand(input);
51
51
  * const response = await client.send(command);
52
+ * // { // NotificationConfiguration
53
+ * // TopicConfigurations: [ // TopicConfigurationList
54
+ * // { // TopicConfiguration
55
+ * // Id: "STRING_VALUE",
56
+ * // TopicArn: "STRING_VALUE", // required
57
+ * // Events: [ // EventList // required
58
+ * // "s3:ReducedRedundancyLostObject" || "s3:ObjectCreated:*" || "s3:ObjectCreated:Put" || "s3:ObjectCreated:Post" || "s3:ObjectCreated:Copy" || "s3:ObjectCreated:CompleteMultipartUpload" || "s3:ObjectRemoved:*" || "s3:ObjectRemoved:Delete" || "s3:ObjectRemoved:DeleteMarkerCreated" || "s3:ObjectRestore:*" || "s3:ObjectRestore:Post" || "s3:ObjectRestore:Completed" || "s3:Replication:*" || "s3:Replication:OperationFailedReplication" || "s3:Replication:OperationNotTracked" || "s3:Replication:OperationMissedThreshold" || "s3:Replication:OperationReplicatedAfterThreshold" || "s3:ObjectRestore:Delete" || "s3:LifecycleTransition" || "s3:IntelligentTiering" || "s3:ObjectAcl:Put" || "s3:LifecycleExpiration:*" || "s3:LifecycleExpiration:Delete" || "s3:LifecycleExpiration:DeleteMarkerCreated" || "s3:ObjectTagging:*" || "s3:ObjectTagging:Put" || "s3:ObjectTagging:Delete",
59
+ * // ],
60
+ * // Filter: { // NotificationConfigurationFilter
61
+ * // Key: { // S3KeyFilter
62
+ * // FilterRules: [ // FilterRuleList
63
+ * // { // FilterRule
64
+ * // Name: "prefix" || "suffix",
65
+ * // Value: "STRING_VALUE",
66
+ * // },
67
+ * // ],
68
+ * // },
69
+ * // },
70
+ * // },
71
+ * // ],
72
+ * // QueueConfigurations: [ // QueueConfigurationList
73
+ * // { // QueueConfiguration
74
+ * // Id: "STRING_VALUE",
75
+ * // QueueArn: "STRING_VALUE", // required
76
+ * // Events: [ // required
77
+ * // "s3:ReducedRedundancyLostObject" || "s3:ObjectCreated:*" || "s3:ObjectCreated:Put" || "s3:ObjectCreated:Post" || "s3:ObjectCreated:Copy" || "s3:ObjectCreated:CompleteMultipartUpload" || "s3:ObjectRemoved:*" || "s3:ObjectRemoved:Delete" || "s3:ObjectRemoved:DeleteMarkerCreated" || "s3:ObjectRestore:*" || "s3:ObjectRestore:Post" || "s3:ObjectRestore:Completed" || "s3:Replication:*" || "s3:Replication:OperationFailedReplication" || "s3:Replication:OperationNotTracked" || "s3:Replication:OperationMissedThreshold" || "s3:Replication:OperationReplicatedAfterThreshold" || "s3:ObjectRestore:Delete" || "s3:LifecycleTransition" || "s3:IntelligentTiering" || "s3:ObjectAcl:Put" || "s3:LifecycleExpiration:*" || "s3:LifecycleExpiration:Delete" || "s3:LifecycleExpiration:DeleteMarkerCreated" || "s3:ObjectTagging:*" || "s3:ObjectTagging:Put" || "s3:ObjectTagging:Delete",
78
+ * // ],
79
+ * // Filter: {
80
+ * // Key: {
81
+ * // FilterRules: [
82
+ * // {
83
+ * // Name: "prefix" || "suffix",
84
+ * // Value: "STRING_VALUE",
85
+ * // },
86
+ * // ],
87
+ * // },
88
+ * // },
89
+ * // },
90
+ * // ],
91
+ * // LambdaFunctionConfigurations: [ // LambdaFunctionConfigurationList
92
+ * // { // LambdaFunctionConfiguration
93
+ * // Id: "STRING_VALUE",
94
+ * // LambdaFunctionArn: "STRING_VALUE", // required
95
+ * // Events: [ // required
96
+ * // "s3:ReducedRedundancyLostObject" || "s3:ObjectCreated:*" || "s3:ObjectCreated:Put" || "s3:ObjectCreated:Post" || "s3:ObjectCreated:Copy" || "s3:ObjectCreated:CompleteMultipartUpload" || "s3:ObjectRemoved:*" || "s3:ObjectRemoved:Delete" || "s3:ObjectRemoved:DeleteMarkerCreated" || "s3:ObjectRestore:*" || "s3:ObjectRestore:Post" || "s3:ObjectRestore:Completed" || "s3:Replication:*" || "s3:Replication:OperationFailedReplication" || "s3:Replication:OperationNotTracked" || "s3:Replication:OperationMissedThreshold" || "s3:Replication:OperationReplicatedAfterThreshold" || "s3:ObjectRestore:Delete" || "s3:LifecycleTransition" || "s3:IntelligentTiering" || "s3:ObjectAcl:Put" || "s3:LifecycleExpiration:*" || "s3:LifecycleExpiration:Delete" || "s3:LifecycleExpiration:DeleteMarkerCreated" || "s3:ObjectTagging:*" || "s3:ObjectTagging:Put" || "s3:ObjectTagging:Delete",
97
+ * // ],
98
+ * // Filter: {
99
+ * // Key: {
100
+ * // FilterRules: [
101
+ * // {
102
+ * // Name: "prefix" || "suffix",
103
+ * // Value: "STRING_VALUE",
104
+ * // },
105
+ * // ],
106
+ * // },
107
+ * // },
108
+ * // },
109
+ * // ],
110
+ * // EventBridgeConfiguration: {},
111
+ * // };
112
+ *
52
113
  * ```
53
114
  *
54
115
  * @param GetBucketNotificationConfigurationCommandInput - {@link GetBucketNotificationConfigurationCommandInput}
@@ -57,6 +118,8 @@ export interface GetBucketNotificationConfigurationCommandOutput extends Notific
57
118
  * @see {@link GetBucketNotificationConfigurationCommandOutput} for command's `response` shape.
58
119
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
59
120
  *
121
+ * @throws {@link S3ServiceException}
122
+ * <p>Base exception class for all service exceptions from S3 service.</p>
60
123
  *
61
124
  */
62
125
  export declare class GetBucketNotificationConfigurationCommand extends $Command<GetBucketNotificationConfigurationCommandInput, GetBucketNotificationConfigurationCommandOutput, S3ClientResolvedConfig> {
@@ -49,6 +49,16 @@ export interface GetBucketOwnershipControlsCommandOutput extends GetBucketOwners
49
49
  * };
50
50
  * const command = new GetBucketOwnershipControlsCommand(input);
51
51
  * const response = await client.send(command);
52
+ * // { // GetBucketOwnershipControlsOutput
53
+ * // OwnershipControls: { // OwnershipControls
54
+ * // Rules: [ // OwnershipControlsRules // required
55
+ * // { // OwnershipControlsRule
56
+ * // ObjectOwnership: "BucketOwnerPreferred" || "ObjectWriter" || "BucketOwnerEnforced", // required
57
+ * // },
58
+ * // ],
59
+ * // },
60
+ * // };
61
+ *
52
62
  * ```
53
63
  *
54
64
  * @param GetBucketOwnershipControlsCommandInput - {@link GetBucketOwnershipControlsCommandInput}
@@ -57,6 +67,8 @@ export interface GetBucketOwnershipControlsCommandOutput extends GetBucketOwners
57
67
  * @see {@link GetBucketOwnershipControlsCommandOutput} for command's `response` shape.
58
68
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
59
69
  *
70
+ * @throws {@link S3ServiceException}
71
+ * <p>Base exception class for all service exceptions from S3 service.</p>
60
72
  *
61
73
  */
62
74
  export declare class GetBucketOwnershipControlsCommand extends $Command<GetBucketOwnershipControlsCommandInput, GetBucketOwnershipControlsCommandOutput, S3ClientResolvedConfig> {
@@ -54,6 +54,10 @@ export interface GetBucketPolicyCommandOutput extends GetBucketPolicyOutput, __M
54
54
  * };
55
55
  * const command = new GetBucketPolicyCommand(input);
56
56
  * const response = await client.send(command);
57
+ * // { // GetBucketPolicyOutput
58
+ * // Policy: "STRING_VALUE",
59
+ * // };
60
+ *
57
61
  * ```
58
62
  *
59
63
  * @param GetBucketPolicyCommandInput - {@link GetBucketPolicyCommandInput}
@@ -62,6 +66,8 @@ export interface GetBucketPolicyCommandOutput extends GetBucketPolicyOutput, __M
62
66
  * @see {@link GetBucketPolicyCommandOutput} for command's `response` shape.
63
67
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
64
68
  *
69
+ * @throws {@link S3ServiceException}
70
+ * <p>Base exception class for all service exceptions from S3 service.</p>
65
71
  *
66
72
  * @example To get bucket policy
67
73
  * ```javascript
@@ -60,6 +60,12 @@ export interface GetBucketPolicyStatusCommandOutput extends GetBucketPolicyStatu
60
60
  * };
61
61
  * const command = new GetBucketPolicyStatusCommand(input);
62
62
  * const response = await client.send(command);
63
+ * // { // GetBucketPolicyStatusOutput
64
+ * // PolicyStatus: { // PolicyStatus
65
+ * // IsPublic: true || false,
66
+ * // },
67
+ * // };
68
+ *
63
69
  * ```
64
70
  *
65
71
  * @param GetBucketPolicyStatusCommandInput - {@link GetBucketPolicyStatusCommandInput}
@@ -68,6 +74,8 @@ export interface GetBucketPolicyStatusCommandOutput extends GetBucketPolicyStatu
68
74
  * @see {@link GetBucketPolicyStatusCommandOutput} for command's `response` shape.
69
75
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
70
76
  *
77
+ * @throws {@link S3ServiceException}
78
+ * <p>Base exception class for all service exceptions from S3 service.</p>
71
79
  *
72
80
  */
73
81
  export declare class GetBucketPolicyStatusCommand extends $Command<GetBucketPolicyStatusCommandInput, GetBucketPolicyStatusCommandOutput, S3ClientResolvedConfig> {
@@ -61,6 +61,73 @@ export interface GetBucketReplicationCommandOutput extends GetBucketReplicationO
61
61
  * };
62
62
  * const command = new GetBucketReplicationCommand(input);
63
63
  * const response = await client.send(command);
64
+ * // { // GetBucketReplicationOutput
65
+ * // ReplicationConfiguration: { // ReplicationConfiguration
66
+ * // Role: "STRING_VALUE", // required
67
+ * // Rules: [ // ReplicationRules // required
68
+ * // { // ReplicationRule
69
+ * // ID: "STRING_VALUE",
70
+ * // Priority: Number("int"),
71
+ * // Prefix: "STRING_VALUE",
72
+ * // Filter: { // ReplicationRuleFilter Union: only one key present
73
+ * // Prefix: "STRING_VALUE",
74
+ * // Tag: { // Tag
75
+ * // Key: "STRING_VALUE", // required
76
+ * // Value: "STRING_VALUE", // required
77
+ * // },
78
+ * // And: { // ReplicationRuleAndOperator
79
+ * // Prefix: "STRING_VALUE",
80
+ * // Tags: [ // TagSet
81
+ * // {
82
+ * // Key: "STRING_VALUE", // required
83
+ * // Value: "STRING_VALUE", // required
84
+ * // },
85
+ * // ],
86
+ * // },
87
+ * // },
88
+ * // Status: "Enabled" || "Disabled", // required
89
+ * // SourceSelectionCriteria: { // SourceSelectionCriteria
90
+ * // SseKmsEncryptedObjects: { // SseKmsEncryptedObjects
91
+ * // Status: "Enabled" || "Disabled", // required
92
+ * // },
93
+ * // ReplicaModifications: { // ReplicaModifications
94
+ * // Status: "Enabled" || "Disabled", // required
95
+ * // },
96
+ * // },
97
+ * // ExistingObjectReplication: { // ExistingObjectReplication
98
+ * // Status: "Enabled" || "Disabled", // required
99
+ * // },
100
+ * // Destination: { // Destination
101
+ * // Bucket: "STRING_VALUE", // required
102
+ * // Account: "STRING_VALUE",
103
+ * // StorageClass: "STANDARD" || "REDUCED_REDUNDANCY" || "STANDARD_IA" || "ONEZONE_IA" || "INTELLIGENT_TIERING" || "GLACIER" || "DEEP_ARCHIVE" || "OUTPOSTS" || "GLACIER_IR" || "SNOW",
104
+ * // AccessControlTranslation: { // AccessControlTranslation
105
+ * // Owner: "Destination", // required
106
+ * // },
107
+ * // EncryptionConfiguration: { // EncryptionConfiguration
108
+ * // ReplicaKmsKeyID: "STRING_VALUE",
109
+ * // },
110
+ * // ReplicationTime: { // ReplicationTime
111
+ * // Status: "Enabled" || "Disabled", // required
112
+ * // Time: { // ReplicationTimeValue
113
+ * // Minutes: Number("int"),
114
+ * // },
115
+ * // },
116
+ * // Metrics: { // Metrics
117
+ * // Status: "Enabled" || "Disabled", // required
118
+ * // EventThreshold: {
119
+ * // Minutes: Number("int"),
120
+ * // },
121
+ * // },
122
+ * // },
123
+ * // DeleteMarkerReplication: { // DeleteMarkerReplication
124
+ * // Status: "Enabled" || "Disabled",
125
+ * // },
126
+ * // },
127
+ * // ],
128
+ * // },
129
+ * // };
130
+ *
64
131
  * ```
65
132
  *
66
133
  * @param GetBucketReplicationCommandInput - {@link GetBucketReplicationCommandInput}
@@ -69,6 +136,8 @@ export interface GetBucketReplicationCommandOutput extends GetBucketReplicationO
69
136
  * @see {@link GetBucketReplicationCommandOutput} for command's `response` shape.
70
137
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
71
138
  *
139
+ * @throws {@link S3ServiceException}
140
+ * <p>Base exception class for all service exceptions from S3 service.</p>
72
141
  *
73
142
  * @example To get replication configuration set on a bucket
74
143
  * ```javascript
@@ -41,6 +41,10 @@ export interface GetBucketRequestPaymentCommandOutput extends GetBucketRequestPa
41
41
  * };
42
42
  * const command = new GetBucketRequestPaymentCommand(input);
43
43
  * const response = await client.send(command);
44
+ * // { // GetBucketRequestPaymentOutput
45
+ * // Payer: "Requester" || "BucketOwner",
46
+ * // };
47
+ *
44
48
  * ```
45
49
  *
46
50
  * @param GetBucketRequestPaymentCommandInput - {@link GetBucketRequestPaymentCommandInput}
@@ -49,6 +53,8 @@ export interface GetBucketRequestPaymentCommandOutput extends GetBucketRequestPa
49
53
  * @see {@link GetBucketRequestPaymentCommandOutput} for command's `response` shape.
50
54
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
51
55
  *
56
+ * @throws {@link S3ServiceException}
57
+ * <p>Base exception class for all service exceptions from S3 service.</p>
52
58
  *
53
59
  * @example To get bucket versioning configuration
54
60
  * ```javascript