@aws-sdk/client-s3 3.326.0 → 3.328.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 (87) hide show
  1. package/dist-types/commands/AbortMultipartUploadCommand.d.ts +2 -2
  2. package/dist-types/commands/CompleteMultipartUploadCommand.d.ts +22 -14
  3. package/dist-types/commands/CopyObjectCommand.d.ts +171 -144
  4. package/dist-types/commands/CreateBucketCommand.d.ts +128 -118
  5. package/dist-types/commands/CreateMultipartUploadCommand.d.ts +73 -48
  6. package/dist-types/commands/DeleteBucketAnalyticsConfigurationCommand.d.ts +2 -2
  7. package/dist-types/commands/DeleteBucketCommand.d.ts +1 -3
  8. package/dist-types/commands/DeleteBucketCorsCommand.d.ts +3 -5
  9. package/dist-types/commands/DeleteBucketEncryptionCommand.d.ts +8 -8
  10. package/dist-types/commands/DeleteBucketIntelligentTieringConfigurationCommand.d.ts +1 -2
  11. package/dist-types/commands/DeleteBucketInventoryConfigurationCommand.d.ts +2 -2
  12. package/dist-types/commands/DeleteBucketLifecycleCommand.d.ts +1 -2
  13. package/dist-types/commands/DeleteBucketMetricsConfigurationCommand.d.ts +5 -5
  14. package/dist-types/commands/DeleteBucketOwnershipControlsCommand.d.ts +2 -2
  15. package/dist-types/commands/DeleteBucketPolicyCommand.d.ts +6 -3
  16. package/dist-types/commands/DeleteBucketReplicationCommand.d.ts +4 -3
  17. package/dist-types/commands/DeleteObjectCommand.d.ts +21 -21
  18. package/dist-types/commands/DeleteObjectTaggingCommand.d.ts +13 -15
  19. package/dist-types/commands/DeleteObjectsCommand.d.ts +35 -36
  20. package/dist-types/commands/DeletePublicAccessBlockCommand.d.ts +2 -2
  21. package/dist-types/commands/GetBucketAccelerateConfigurationCommand.d.ts +6 -7
  22. package/dist-types/commands/GetBucketAclCommand.d.ts +14 -10
  23. package/dist-types/commands/GetBucketAnalyticsConfigurationCommand.d.ts +6 -7
  24. package/dist-types/commands/GetBucketCorsCommand.d.ts +5 -0
  25. package/dist-types/commands/GetBucketEncryptionCommand.d.ts +7 -7
  26. package/dist-types/commands/GetBucketIntelligentTieringConfigurationCommand.d.ts +1 -2
  27. package/dist-types/commands/GetBucketInventoryConfigurationCommand.d.ts +2 -2
  28. package/dist-types/commands/GetBucketLifecycleConfigurationCommand.d.ts +4 -4
  29. package/dist-types/commands/GetBucketLocationCommand.d.ts +10 -2
  30. package/dist-types/commands/GetBucketLoggingCommand.d.ts +1 -1
  31. package/dist-types/commands/GetBucketMetricsConfigurationCommand.d.ts +5 -6
  32. package/dist-types/commands/GetBucketNotificationConfigurationCommand.d.ts +7 -2
  33. package/dist-types/commands/GetBucketOwnershipControlsCommand.d.ts +4 -3
  34. package/dist-types/commands/GetBucketPolicyCommand.d.ts +11 -3
  35. package/dist-types/commands/GetBucketPolicyStatusCommand.d.ts +1 -1
  36. package/dist-types/commands/GetBucketRequestPaymentCommand.d.ts +2 -1
  37. package/dist-types/commands/GetBucketWebsiteCommand.d.ts +2 -3
  38. package/dist-types/commands/GetObjectAclCommand.d.ts +5 -7
  39. package/dist-types/commands/GetObjectAttributesCommand.d.ts +42 -45
  40. package/dist-types/commands/GetObjectCommand.d.ts +116 -112
  41. package/dist-types/commands/GetObjectLockConfigurationCommand.d.ts +1 -2
  42. package/dist-types/commands/GetObjectRetentionCommand.d.ts +2 -1
  43. package/dist-types/commands/GetObjectTaggingCommand.d.ts +5 -5
  44. package/dist-types/commands/GetObjectTorrentCommand.d.ts +1 -1
  45. package/dist-types/commands/GetPublicAccessBlockCommand.d.ts +1 -1
  46. package/dist-types/commands/HeadBucketCommand.d.ts +19 -9
  47. package/dist-types/commands/HeadObjectCommand.d.ts +36 -33
  48. package/dist-types/commands/ListBucketAnalyticsConfigurationsCommand.d.ts +4 -4
  49. package/dist-types/commands/ListBucketIntelligentTieringConfigurationsCommand.d.ts +1 -2
  50. package/dist-types/commands/ListBucketInventoryConfigurationsCommand.d.ts +5 -5
  51. package/dist-types/commands/ListBucketMetricsConfigurationsCommand.d.ts +6 -7
  52. package/dist-types/commands/ListBucketsCommand.d.ts +9 -7
  53. package/dist-types/commands/ListMultipartUploadsCommand.d.ts +2 -2
  54. package/dist-types/commands/ListObjectVersionsCommand.d.ts +3 -6
  55. package/dist-types/commands/ListObjectsV2Command.d.ts +13 -14
  56. package/dist-types/commands/ListPartsCommand.d.ts +3 -4
  57. package/dist-types/commands/PutBucketAccelerateConfigurationCommand.d.ts +4 -3
  58. package/dist-types/commands/PutBucketAclCommand.d.ts +114 -111
  59. package/dist-types/commands/PutBucketAnalyticsConfigurationCommand.d.ts +7 -10
  60. package/dist-types/commands/PutBucketCorsCommand.d.ts +3 -5
  61. package/dist-types/commands/PutBucketEncryptionCommand.d.ts +17 -17
  62. package/dist-types/commands/PutBucketIntelligentTieringConfigurationCommand.d.ts +31 -59
  63. package/dist-types/commands/PutBucketInventoryConfigurationCommand.d.ts +50 -65
  64. package/dist-types/commands/PutBucketLifecycleConfigurationCommand.d.ts +64 -62
  65. package/dist-types/commands/PutBucketLoggingCommand.d.ts +45 -39
  66. package/dist-types/commands/PutBucketMetricsConfigurationCommand.d.ts +4 -4
  67. package/dist-types/commands/PutBucketNotificationConfigurationCommand.d.ts +9 -12
  68. package/dist-types/commands/PutBucketOwnershipControlsCommand.d.ts +4 -2
  69. package/dist-types/commands/PutBucketPolicyCommand.d.ts +8 -4
  70. package/dist-types/commands/PutBucketReplicationCommand.d.ts +31 -28
  71. package/dist-types/commands/PutBucketRequestPaymentCommand.d.ts +1 -1
  72. package/dist-types/commands/PutBucketTaggingCommand.d.ts +12 -12
  73. package/dist-types/commands/PutBucketVersioningCommand.d.ts +7 -9
  74. package/dist-types/commands/PutObjectAclCommand.d.ts +123 -119
  75. package/dist-types/commands/PutObjectCommand.d.ts +81 -90
  76. package/dist-types/commands/PutObjectLockConfigurationCommand.d.ts +7 -8
  77. package/dist-types/commands/PutObjectRetentionCommand.d.ts +3 -4
  78. package/dist-types/commands/PutObjectTaggingCommand.d.ts +7 -9
  79. package/dist-types/commands/PutPublicAccessBlockCommand.d.ts +2 -4
  80. package/dist-types/commands/RestoreObjectCommand.d.ts +175 -199
  81. package/dist-types/commands/SelectObjectContentCommand.d.ts +83 -90
  82. package/dist-types/commands/UploadPartCommand.d.ts +26 -22
  83. package/dist-types/commands/UploadPartCopyCommand.d.ts +78 -76
  84. package/dist-types/commands/WriteGetObjectResponseCommand.d.ts +32 -21
  85. package/dist-types/models/models_0.d.ts +468 -382
  86. package/dist-types/models/models_1.d.ts +82 -80
  87. package/package.json +9 -9
@@ -19,7 +19,8 @@ export interface GetObjectRetentionCommandOutput extends GetObjectRetentionOutpu
19
19
  }
20
20
  /**
21
21
  * @public
22
- * <p>Retrieves an object's retention settings. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Locking Objects</a>.</p>
22
+ * <p>Retrieves an object's retention settings. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Locking
23
+ * Objects</a>.</p>
23
24
  * <p>This action is not supported by Amazon S3 on Outposts.</p>
24
25
  * <p>The following action is related to <code>GetObjectRetention</code>:</p>
25
26
  * <ul>
@@ -22,11 +22,11 @@ export interface GetObjectTaggingCommandOutput extends GetObjectTaggingOutput, _
22
22
  * <p>Returns the tag-set of an object. You send the GET request against the tagging
23
23
  * subresource associated with the object.</p>
24
24
  * <p>To use this operation, you must have permission to perform the
25
- * <code>s3:GetObjectTagging</code> action. By default, the GET action returns
26
- * information about current version of an object. For a versioned bucket, you can have
27
- * multiple versions of an object in your bucket. To retrieve tags of any other version, use
28
- * the versionId query parameter. You also need permission for the
29
- * <code>s3:GetObjectVersionTagging</code> action.</p>
25
+ * <code>s3:GetObjectTagging</code> action. By default, the GET action returns information
26
+ * about current version of an object. For a versioned bucket, you can have multiple versions
27
+ * of an object in your bucket. To retrieve tags of any other version, use the versionId query
28
+ * parameter. You also need permission for the <code>s3:GetObjectVersionTagging</code>
29
+ * action.</p>
30
30
  * <p> By default, the bucket owner has this permission and can grant this permission to
31
31
  * others.</p>
32
32
  * <p> For information about the Amazon S3 object tagging feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html">Object Tagging</a>.</p>
@@ -20,7 +20,7 @@ export interface GetObjectTorrentCommandOutput extends __WithSdkStreamMixin<GetO
20
20
  /**
21
21
  * @public
22
22
  * <p>Returns torrent files from a bucket. BitTorrent can save you bandwidth when you're
23
- * distributing large files. For more information about BitTorrent, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/S3Torrent.html">Using BitTorrent with Amazon S3</a>.</p>
23
+ * distributing large files.</p>
24
24
  * <note>
25
25
  * <p>You can get torrent only for objects that are less than 5 GB in size, and that are
26
26
  * not encrypted using server-side encryption with a customer-provided encryption
@@ -22,7 +22,7 @@ export interface GetPublicAccessBlockCommandOutput extends GetPublicAccessBlockO
22
22
  * <p>Retrieves the <code>PublicAccessBlock</code> configuration for an Amazon S3 bucket. To use
23
23
  * this operation, you must have the <code>s3:GetBucketPublicAccessBlock</code> permission.
24
24
  * For more information about Amazon S3 permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying Permissions in a
25
- * Policy</a>.</p>
25
+ * Policy</a>.</p>
26
26
  * <important>
27
27
  * <p>When Amazon S3 evaluates the <code>PublicAccessBlock</code> configuration for a bucket or
28
28
  * an object, it checks the <code>PublicAccessBlock</code> configuration for both the
@@ -19,17 +19,27 @@ export interface HeadBucketCommandOutput extends __MetadataBearer {
19
19
  }
20
20
  /**
21
21
  * @public
22
- * <p>This action is useful to determine if a bucket exists and you have permission to
23
- * access it. The action returns a <code>200 OK</code> if the bucket exists and you have
24
- * permission to access it.</p>
25
- * <p>If the bucket does not exist or you do not have permission to access it, the <code>HEAD</code> request
26
- * returns a generic <code>404 Not Found</code> or <code>403 Forbidden</code> code. A message body is not
27
- * included, so you cannot determine the exception beyond these error codes.</p>
22
+ * <p>This action is useful to determine if a bucket exists and you have permission to access
23
+ * it. The action returns a <code>200 OK</code> if the bucket exists and you have permission
24
+ * to access it.</p>
25
+ * <p>If the bucket does not exist or you do not have permission to access it, the
26
+ * <code>HEAD</code> request returns a generic <code>400 Bad Request</code>, <code>403
27
+ * Forbidden</code> or <code>404 Not Found</code> code. A message body is not included, so
28
+ * you cannot determine the exception beyond these error codes.</p>
28
29
  * <p>To use this operation, you must have permissions to perform the
29
30
  * <code>s3:ListBucket</code> action. The bucket owner has this permission by default and
30
- * can grant this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3
31
- * Resources</a>.</p>
32
- * <p>To use this API against 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 AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using the Amazon Web Services SDKs, you provide the ARN in place of the bucket name. For more information see, <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a>.</p>
31
+ * can grant this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing
32
+ * Access Permissions to Your Amazon S3 Resources</a>.</p>
33
+ * <p>To use this API operation against an access point, you must provide the alias of the access point in place of the
34
+ * bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to
35
+ * the access point hostname. The access point hostname takes the form
36
+ * <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com.
37
+ * When using the Amazon Web Services SDKs, you provide the ARN in place of the bucket name. For more
38
+ * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a>.</p>
39
+ * <p>To use this API operation against an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name.
40
+ * If the Object Lambda access point alias in a request is not valid, the error code <code>InvalidAccessPointAliasError</code> is returned.
41
+ * For more information about <code>InvalidAccessPointAliasError</code>, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList">List of
42
+ * Error Codes</a>.</p>
33
43
  * @example
34
44
  * Use a bare-bones client and the command you need to make an API call.
35
45
  * ```javascript
@@ -19,14 +19,15 @@ export interface HeadObjectCommandOutput extends HeadObjectOutput, __MetadataBea
19
19
  }
20
20
  /**
21
21
  * @public
22
- * <p>The HEAD action retrieves metadata from an object without returning the object
23
- * itself. This action is useful if you're only interested in an object's metadata. To use
24
- * HEAD, you must have READ access to the object.</p>
22
+ * <p>The HEAD action retrieves metadata from an object without returning the object itself.
23
+ * This action is useful if you're only interested in an object's metadata. To use HEAD, you
24
+ * must have READ access to the object.</p>
25
25
  * <p>A <code>HEAD</code> request has the same options as a <code>GET</code> action on an
26
26
  * object. The response is identical to the <code>GET</code> response except that there is no
27
27
  * response body. Because of this, if the <code>HEAD</code> request generates an error, it
28
- * returns a generic <code>404 Not Found</code> or <code>403 Forbidden</code> code. It is not
29
- * possible to retrieve the exact exception beyond these error codes.</p>
28
+ * returns a generic <code>400 Bad Request</code>, <code>403 Forbidden</code> or <code>404 Not
29
+ * Found</code> code. It is not possible to retrieve the exact exception beyond these error
30
+ * codes.</p>
30
31
  * <p>If you encrypt an object by using server-side encryption with customer-provided
31
32
  * encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the
32
33
  * metadata from the object, you must use the following headers:</p>
@@ -41,25 +42,25 @@ export interface HeadObjectCommandOutput extends HeadObjectOutput, __MetadataBea
41
42
  * <p>x-amz-server-side-encryption-customer-key-MD5</p>
42
43
  * </li>
43
44
  * </ul>
44
- * <p>For more information about SSE-C, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side Encryption (Using
45
- * Customer-Provided Encryption Keys)</a>.</p>
45
+ * <p>For more information about SSE-C, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side Encryption
46
+ * (Using Customer-Provided Encryption Keys)</a>.</p>
46
47
  * <note>
47
48
  * <ul>
48
49
  * <li>
49
- * <p>Encryption request headers, like <code>x-amz-server-side-encryption</code>, should
50
- * not be sent for GET requests if your object uses server-side encryption with KMS keys (SSE-KMS)
51
- * or server-side encryption with Amazon S3–managed encryption keys
52
- * (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 BadRequest
53
- * error.</p>
50
+ * <p>Encryption request headers, like <code>x-amz-server-side-encryption</code>,
51
+ * should not be sent for GET requests if your object uses server-side encryption
52
+ * with KMS keys (SSE-KMS) or server-side encryption with Amazon S3–managed encryption
53
+ * keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400
54
+ * BadRequest error.</p>
54
55
  * </li>
55
56
  * <li>
56
- * <p>
57
- * The last modified property in this case is the creation date of the object.</p>
57
+ * <p> The last modified property in this case is the creation date of the
58
+ * object.</p>
58
59
  * </li>
59
60
  * </ul>
60
61
  * </note>
61
- * <p>Request headers are limited to 8 KB in size. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTCommonRequestHeaders.html">Common Request
62
- * Headers</a>.</p>
62
+ * <p>Request headers are limited to 8 KB in size. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTCommonRequestHeaders.html">Common
63
+ * Request Headers</a>.</p>
63
64
  * <p>Consider the following when using request headers:</p>
64
65
  * <ul>
65
66
  * <li>
@@ -99,23 +100,25 @@ export interface HeadObjectCommandOutput extends HeadObjectOutput, __MetadataBea
99
100
  * </li>
100
101
  * </ul>
101
102
  * <p>For more information about conditional requests, see <a href="https://tools.ietf.org/html/rfc7232">RFC 7232</a>.</p>
102
- * <p>
103
- * <b>Permissions</b>
104
- * </p>
105
- * <p>You need the relevant read object (or version) permission for this operation. For more
106
- * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying Permissions
107
- * in a Policy</a>. If the object you request does not exist, the error Amazon S3 returns
108
- * depends on whether you also have the s3:ListBucket permission.</p>
109
- * <ul>
110
- * <li>
111
- * <p>If you have the <code>s3:ListBucket</code> permission on the bucket, Amazon S3 returns
112
- * an HTTP status code 404 ("no such key") error.</p>
113
- * </li>
114
- * <li>
115
- * <p>If you don’t have the <code>s3:ListBucket</code> permission, Amazon S3 returns an HTTP
116
- * status code 403 ("access denied") error.</p>
117
- * </li>
118
- * </ul>
103
+ * <dl>
104
+ * <dt>Permissions</dt>
105
+ * <dd>
106
+ * <p>You need the relevant read object (or version) permission for this operation. For more
107
+ * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/list_amazons3.html">Actions, resources, and condition keys for Amazon S3</a>.
108
+ * If the object you request does not exist, the error Amazon S3 returns depends
109
+ * on whether you also have the s3:ListBucket permission.</p>
110
+ * <ul>
111
+ * <li>
112
+ * <p>If you have the <code>s3:ListBucket</code> permission on the bucket, Amazon S3 returns
113
+ * an HTTP status code 404 ("no such key") error.</p>
114
+ * </li>
115
+ * <li>
116
+ * <p>If you don’t have the <code>s3:ListBucket</code> permission, Amazon S3 returns an HTTP
117
+ * status code 403 ("access denied") error.</p>
118
+ * </li>
119
+ * </ul>
120
+ * </dd>
121
+ * </dl>
119
122
  * <p>The following actions are related to <code>HeadObject</code>:</p>
120
123
  * <ul>
121
124
  * <li>
@@ -21,8 +21,8 @@ export interface ListBucketAnalyticsConfigurationsCommandOutput extends ListBuck
21
21
  * @public
22
22
  * <p>Lists the analytics configurations for the bucket. You can have up to 1,000 analytics
23
23
  * configurations per bucket.</p>
24
- * <p>This action supports list pagination and does not return more than 100 configurations
25
- * at a time. You should always check the <code>IsTruncated</code> element in the response. If
24
+ * <p>This action supports list pagination and does not return more than 100 configurations at
25
+ * a time. You should always check the <code>IsTruncated</code> element in the response. If
26
26
  * there are no more configurations to list, <code>IsTruncated</code> is set to false. If
27
27
  * there are more configurations to list, <code>IsTruncated</code> is set to true, and there
28
28
  * will be a value in <code>NextContinuationToken</code>. You use the
@@ -32,8 +32,8 @@ export interface ListBucketAnalyticsConfigurationsCommandOutput extends ListBuck
32
32
  * <p>To use this operation, you must have permissions to perform the
33
33
  * <code>s3:GetAnalyticsConfiguration</code> action. The bucket owner has this permission
34
34
  * by default. The bucket owner can grant this permission to others. For more information
35
- * about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3
36
- * Resources</a>.</p>
35
+ * about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing
36
+ * Access Permissions to Your Amazon S3 Resources</a>.</p>
37
37
  * <p>For information about Amazon S3 analytics feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html">Amazon S3 Analytics – Storage Class
38
38
  * Analysis</a>. </p>
39
39
  * <p>The following operations are related to
@@ -23,8 +23,7 @@ export interface ListBucketIntelligentTieringConfigurationsCommandOutput extends
23
23
  * <p>The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.</p>
24
24
  * <p>The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.</p>
25
25
  * <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access">Storage class for automatically optimizing frequently and infrequently accessed objects</a>.</p>
26
- * <p>Operations related to
27
- * <code>ListBucketIntelligentTieringConfigurations</code> include: </p>
26
+ * <p>Operations related to <code>ListBucketIntelligentTieringConfigurations</code> include: </p>
28
27
  * <ul>
29
28
  * <li>
30
29
  * <p>
@@ -21,9 +21,9 @@ export interface ListBucketInventoryConfigurationsCommandOutput extends ListBuck
21
21
  * @public
22
22
  * <p>Returns a list of inventory configurations for the bucket. You can have up to 1,000
23
23
  * analytics configurations per bucket.</p>
24
- * <p>This action supports list pagination and does not return more than 100 configurations
25
- * at a time. Always check the <code>IsTruncated</code> element in the response. If there are
26
- * no more configurations to list, <code>IsTruncated</code> is set to false. If there are more
24
+ * <p>This action supports list pagination and does not return more than 100 configurations at
25
+ * a time. Always check the <code>IsTruncated</code> element in the response. If there are no
26
+ * more configurations to list, <code>IsTruncated</code> is set to false. If there are more
27
27
  * configurations to list, <code>IsTruncated</code> is set to true, and there is a value in
28
28
  * <code>NextContinuationToken</code>. You use the <code>NextContinuationToken</code> value
29
29
  * to continue the pagination of the list by passing the value in continuation-token in the
@@ -31,8 +31,8 @@ export interface ListBucketInventoryConfigurationsCommandOutput extends ListBuck
31
31
  * <p> To use this operation, you must have permissions to perform the
32
32
  * <code>s3:GetInventoryConfiguration</code> action. The bucket owner has this permission
33
33
  * by default. The bucket owner can grant this permission to others. For more information
34
- * about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3
35
- * Resources</a>.</p>
34
+ * about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing
35
+ * Access Permissions to Your Amazon S3 Resources</a>.</p>
36
36
  * <p>For information about the Amazon S3 inventory feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html">Amazon S3 Inventory</a>
37
37
  * </p>
38
38
  * <p>The following operations are related to
@@ -22,9 +22,9 @@ export interface ListBucketMetricsConfigurationsCommandOutput extends ListBucket
22
22
  * <p>Lists the metrics configurations for the bucket. The metrics configurations are only for
23
23
  * the request metrics of the bucket and do not provide information on daily storage metrics.
24
24
  * You can have up to 1,000 configurations per bucket.</p>
25
- * <p>This action supports list pagination and does not return more than 100 configurations
26
- * at a time. Always check the <code>IsTruncated</code> element in the response. If there are
27
- * no more configurations to list, <code>IsTruncated</code> is set to false. If there are more
25
+ * <p>This action supports list pagination and does not return more than 100 configurations at
26
+ * a time. Always check the <code>IsTruncated</code> element in the response. If there are no
27
+ * more configurations to list, <code>IsTruncated</code> is set to false. If there are more
28
28
  * configurations to list, <code>IsTruncated</code> is set to true, and there is a value in
29
29
  * <code>NextContinuationToken</code>. You use the <code>NextContinuationToken</code> value
30
30
  * to continue the pagination of the list by passing the value in
@@ -32,11 +32,10 @@ export interface ListBucketMetricsConfigurationsCommandOutput extends ListBucket
32
32
  * <p>To use this operation, you must have permissions to perform the
33
33
  * <code>s3:GetMetricsConfiguration</code> action. The bucket owner has this permission by
34
34
  * default. The bucket owner can grant this permission to others. For more information about
35
- * permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3
36
- * Resources</a>.</p>
35
+ * permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing
36
+ * Access Permissions to Your Amazon S3 Resources</a>.</p>
37
37
  * <p>For more information about metrics configurations and CloudWatch request metrics, see
38
- * <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html">Monitoring Metrics with Amazon
39
- * CloudWatch</a>.</p>
38
+ * <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html">Monitoring Metrics with Amazon CloudWatch</a>.</p>
40
39
  * <p>The following operations are related to
41
40
  * <code>ListBucketMetricsConfigurations</code>:</p>
42
41
  * <ul>
@@ -20,7 +20,9 @@ export interface ListBucketsCommandOutput extends ListBucketsOutput, __MetadataB
20
20
  /**
21
21
  * @public
22
22
  * <p>Returns a list of all buckets owned by the authenticated sender of the request. To use
23
- * this operation, you must have the <code>s3:ListAllMyBuckets</code> permission.</p>
23
+ * this operation, you must have the <code>s3:ListAllMyBuckets</code> permission. </p>
24
+ * <p>For information about Amazon S3 buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html">Creating, configuring, and
25
+ * working with Amazon S3 buckets</a>.</p>
24
26
  * @example
25
27
  * Use a bare-bones client and the command you need to make an API call.
26
28
  * ```javascript
@@ -54,9 +56,9 @@ export interface ListBucketsCommandOutput extends ListBucketsOutput, __MetadataB
54
56
  * @throws {@link S3ServiceException}
55
57
  * <p>Base exception class for all service exceptions from S3 service.</p>
56
58
  *
57
- * @example To list object versions
59
+ * @example To list all buckets
58
60
  * ```javascript
59
- * // The following example return versions of an object with specific key name prefix. The request limits the number of items returned to two. If there are are more than two object version, S3 returns NextToken in the response. You can specify this token value in your next request to fetch next set of object versions.
61
+ * // The following example returns all the buckets owned by the sender of this request.
60
62
  * const input = undefined;
61
63
  * const command = new ListBucketsCommand(input);
62
64
  * const response = await client.send(command);
@@ -64,15 +66,15 @@ export interface ListBucketsCommandOutput extends ListBucketsOutput, __MetadataB
64
66
  * {
65
67
  * "Buckets": [
66
68
  * {
67
- * "CreationDate": "2012-02-15T21: 03: 02.000Z",
69
+ * "CreationDate": "2012-02-15T21:03:02.000Z",
68
70
  * "Name": "examplebucket"
69
71
  * },
70
72
  * {
71
- * "CreationDate": "2011-07-24T19: 33: 50.000Z",
73
+ * "CreationDate": "2011-07-24T19:33:50.000Z",
72
74
  * "Name": "examplebucket2"
73
75
  * },
74
76
  * {
75
- * "CreationDate": "2010-12-17T00: 56: 49.000Z",
77
+ * "CreationDate": "2010-12-17T00:56:49.000Z",
76
78
  * "Name": "examplebucket3"
77
79
  * }
78
80
  * ],
@@ -82,7 +84,7 @@ export interface ListBucketsCommandOutput extends ListBucketsOutput, __MetadataB
82
84
  * }
83
85
  * }
84
86
  * *\/
85
- * // example id: to-list-object-versions-1481910996058
87
+ * // example id: to-list-buckets-1481910996058
86
88
  * ```
87
89
  *
88
90
  */
@@ -35,8 +35,8 @@ export interface ListMultipartUploadsCommandOutput extends ListMultipartUploadsO
35
35
  * upload initiation time.</p>
36
36
  * <p>For more information on multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html">Uploading Objects Using Multipart
37
37
  * Upload</a>.</p>
38
- * <p>For information on permissions required to use the multipart upload API, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html">Multipart Upload and
39
- * Permissions</a>.</p>
38
+ * <p>For information on permissions required to use the multipart upload API, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html">Multipart Upload
39
+ * and Permissions</a>.</p>
40
40
  * <p>The following operations are related to <code>ListMultipartUploads</code>:</p>
41
41
  * <ul>
42
42
  * <li>
@@ -23,10 +23,8 @@ export interface ListObjectVersionsCommandOutput extends ListObjectVersionsOutpu
23
23
  * parameters as selection criteria to return metadata about a subset of all the object
24
24
  * versions.</p>
25
25
  * <important>
26
- * <p>
27
- * To use this operation, you must have permissions to perform the
28
- * <code>s3:ListBucketVersions</code> action. Be aware of the name difference.
29
- * </p>
26
+ * <p> To use this operation, you must have permissions to perform the
27
+ * <code>s3:ListBucketVersions</code> action. Be aware of the name difference. </p>
30
28
  * </important>
31
29
  * <note>
32
30
  * <p> A 200 OK response can contain valid or invalid XML. Make sure to design your
@@ -34,8 +32,7 @@ export interface ListObjectVersionsCommandOutput extends ListObjectVersionsOutpu
34
32
  * </note>
35
33
  * <p>To use this operation, you must have READ access to the bucket.</p>
36
34
  * <p>This action is not supported by Amazon S3 on Outposts.</p>
37
- * <p>The following operations are related to
38
- * <code>ListObjectVersions</code>:</p>
35
+ * <p>The following operations are related to <code>ListObjectVersions</code>:</p>
39
36
  * <ul>
40
37
  * <li>
41
38
  * <p>
@@ -19,24 +19,23 @@ export interface ListObjectsV2CommandOutput extends ListObjectsV2Output, __Metad
19
19
  }
20
20
  /**
21
21
  * @public
22
- * <p>Returns some or all (up to 1,000) of the objects in a bucket with each request. You can use
23
- * the request parameters as selection criteria to return a subset of the objects in a bucket. A
24
- * <code>200 OK</code> response can contain valid or invalid XML. Make sure to design your
25
- * application to parse the contents of the response and handle it appropriately.
22
+ * <p>Returns some or all (up to 1,000) of the objects in a bucket with each request. You can
23
+ * use the request parameters as selection criteria to return a subset of the objects in a
24
+ * bucket. A <code>200 OK</code> response can contain valid or invalid XML. Make sure to
25
+ * design your application to parse the contents of the response and handle it appropriately.
26
26
  * Objects are returned sorted in an ascending order of the respective key names in the list.
27
27
  * For more information about listing objects, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/ListingKeysUsingAPIs.html">Listing object keys
28
28
  * programmatically</a>
29
29
  * </p>
30
30
  * <p>To use this operation, you must have READ access to the bucket.</p>
31
- * <p>To use this action in an Identity and Access Management (IAM) policy, you must
32
- * have permissions to perform the <code>s3:ListBucket</code> action. The bucket owner has
33
- * this permission by default and can grant this permission to others. For more information
34
- * about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3
35
- * Resources</a>.</p>
31
+ * <p>To use this action in an Identity and Access Management (IAM) policy, you must have permissions to perform
32
+ * the <code>s3:ListBucket</code> action. The bucket owner has this permission by default and
33
+ * can grant this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing
34
+ * Access Permissions to Your Amazon S3 Resources</a>.</p>
36
35
  * <important>
37
- * <p>This section describes the latest revision of this action. We recommend that you use this
38
- * revised API for application development. For backward compatibility, Amazon S3 continues to
39
- * support the prior version of this API, <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html">ListObjects</a>.</p>
36
+ * <p>This section describes the latest revision of this action. We recommend that you use
37
+ * this revised API for application development. For backward compatibility, Amazon S3 continues
38
+ * to support the prior version of this API, <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html">ListObjects</a>.</p>
40
39
  * </important>
41
40
  * <p>To get a list of your buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html">ListBuckets</a>.</p>
42
41
  * <p>The following operations are related to <code>ListObjectsV2</code>:</p>
@@ -129,7 +128,7 @@ export interface ListObjectsV2CommandOutput extends ListObjectsV2Output, __Metad
129
128
  * ```javascript
130
129
  * // The following example retrieves object list. The request specifies max keys to limit response to include only 2 object keys.
131
130
  * const input = {
132
- * "Bucket": "examplebucket",
131
+ * "Bucket": "DOC-EXAMPLE-BUCKET",
133
132
  * "MaxKeys": "2"
134
133
  * };
135
134
  * const command = new ListObjectsV2Command(input);
@@ -155,7 +154,7 @@ export interface ListObjectsV2CommandOutput extends ListObjectsV2Output, __Metad
155
154
  * "IsTruncated": true,
156
155
  * "KeyCount": "2",
157
156
  * "MaxKeys": "2",
158
- * "Name": "examplebucket",
157
+ * "Name": "DOC-EXAMPLE-BUCKET",
159
158
  * "NextContinuationToken": "1w41l63U0xa8q7smH50vCxyTQqdxo69O3EmK28Bi5PcROI4wI/EyIJg==",
160
159
  * "Prefix": ""
161
160
  * }
@@ -30,12 +30,11 @@ export interface ListPartsCommandOutput extends ListPartsOutput, __MetadataBeare
30
30
  * requests you can include the part-number-marker query string parameter and set its value to
31
31
  * the <code>NextPartNumberMarker</code> field value from the previous response.</p>
32
32
  * <p>If the upload was created using a checksum algorithm, you will need to have permission
33
- * to the <code>kms:Decrypt</code> action for the request to succeed.
34
- * </p>
33
+ * to the <code>kms:Decrypt</code> action for the request to succeed. </p>
35
34
  * <p>For more information on multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html">Uploading Objects Using Multipart
36
35
  * Upload</a>.</p>
37
- * <p>For information on permissions required to use the multipart upload API, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html">Multipart Upload and
38
- * Permissions</a>.</p>
36
+ * <p>For information on permissions required to use the multipart upload API, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html">Multipart Upload
37
+ * and Permissions</a>.</p>
39
38
  * <p>The following operations are related to <code>ListParts</code>:</p>
40
39
  * <ul>
41
40
  * <li>
@@ -36,13 +36,14 @@ export interface PutBucketAccelerateConfigurationCommandOutput extends __Metadat
36
36
  * <p> Suspended – Disables accelerated data transfers to the bucket.</p>
37
37
  * </li>
38
38
  * </ul>
39
- * <p>The <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAccelerateConfiguration.html">GetBucketAccelerateConfiguration</a> action returns the transfer acceleration
40
- * state of a bucket.</p>
39
+ * <p>The <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAccelerateConfiguration.html">GetBucketAccelerateConfiguration</a> action returns the transfer acceleration state
40
+ * of a bucket.</p>
41
41
  * <p>After setting the Transfer Acceleration state of a bucket to Enabled, it might take up
42
42
  * to thirty minutes before the data transfer rates to the bucket increase.</p>
43
43
  * <p> The name of the bucket used for Transfer Acceleration must be DNS-compliant and must
44
44
  * not contain periods (".").</p>
45
- * <p> For more information about transfer acceleration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html">Transfer Acceleration</a>.</p>
45
+ * <p> For more information about transfer acceleration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html">Transfer
46
+ * Acceleration</a>.</p>
46
47
  * <p>The following operations are related to
47
48
  * <code>PutBucketAccelerateConfiguration</code>:</p>
48
49
  * <ul>