feat(client-s3): Adding checksum support for S3 PutBucketOwnershipControls API.

Author: awstools

clients/client-s3/src/commands/GetObjectAttributesCommand.ts

@@ -34,11 +34,11 @@ export interface GetObjectAttributesCommandInput extends GetObjectAttributesRequ
 export interface GetObjectAttributesCommandOutput extends GetObjectAttributesOutput, __MetadataBearer {}
 
 /**
- * <p>Retrieves all the metadata from an object without returning the object itself. This
+ * <p>Retrieves all of the metadata from an object without returning the object itself. This
  *          operation is useful if you're interested only in an object's metadata. </p>
  *          <p>
  *             <code>GetObjectAttributes</code> combines the functionality of <code>HeadObject</code>
- *          and <code>ListParts</code>. All of the data returned with each of those individual calls
+ *          and <code>ListParts</code>. All of the data returned with both of those individual calls
  *          can be returned with a single call to <code>GetObjectAttributes</code>.</p>
  *          <note>
  *             <p>
@@ -55,16 +55,24 @@ export interface GetObjectAttributesCommandOutput extends GetObjectAttributesOut
  *                   <li>
  *                      <p>
  *                         <b>General purpose bucket permissions</b> - To
- *                         use <code>GetObjectAttributes</code>, you must have READ access to the
- *                         object. The permissions that you need to use this operation depend on
- *                         whether the bucket is versioned. If the bucket is versioned, you need both
- *                         the <code>s3:GetObjectVersion</code> and
- *                            <code>s3:GetObjectVersionAttributes</code> permissions for this
- *                         operation. If the bucket is not versioned, you need the
+ *                         use <code>GetObjectAttributes</code>, you must have READ access to the object.</p>
+ *                      <p>The other permissions that you need to use this operation depend on
+ *                         whether the bucket is versioned and if a version ID is passed in the <code>GetObjectAttributes</code> request. </p>
+ *                      <ul>
+ *                         <li>
+ *                            <p>If you pass a version ID in your request, you need both the <code>s3:GetObjectVersion</code> and
+ *                            <code>s3:GetObjectVersionAttributes</code> permissions.</p>
+ *                         </li>
+ *                         <li>
+ *                            <p>If you do not pass a version ID in your request, you need the
  *                            <code>s3:GetObject</code> and <code>s3:GetObjectAttributes</code>
- *                         permissions. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying
+ *                         permissions. </p>
+ *                         </li>
+ *                      </ul>
+ *                      <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying
  *                            Permissions in a Policy</a> in the
- *                            <i>Amazon S3 User Guide</i>. If the object that you request does
+ *                            <i>Amazon S3 User Guide</i>.</p>
+ *                      <p>If the object that you request does
  *                         not exist, the error Amazon S3 returns depends on whether you also have the
  *                            <code>s3:ListBucket</code> permission.</p>
  *                      <ul>
@@ -112,10 +120,10 @@ export interface GetObjectAttributesCommandOutput extends GetObjectAttributesOut
  *                      error. It's because the encryption method can't be changed when you retrieve
  *                      the object.</p>
  *                </note>
- *                <p>If you encrypt an object by using server-side encryption with customer-provided
- *                   encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve
- *                   the metadata from the object, you must use the following headers to provide the
- *                   encryption key for the server to be able to retrieve the object's metadata. The
+ *                <p>If you encrypted an object when you stored the object in Amazon S3 by using server-side encryption with customer-provided
+ *                   encryption keys (SSE-C), then when you retrieve
+ *                   the metadata from the object, you must use the following headers. These headers provide the
+ *                   server with the encryption key required to retrieve the object's metadata. The
  *                   headers are: </p>
  *                <ul>
  *                   <li>

clients/client-s3/src/commands/PutBucketOwnershipControlsCommand.ts

@@ -68,6 +68,7 @@ export interface PutBucketOwnershipControlsCommandOutput extends __MetadataBeare
  *       },
  *     ],
  *   },
+ *   ChecksumAlgorithm: "CRC32" || "CRC32C" || "SHA1" || "SHA256" || "CRC64NVME",
  * };
  * const command = new PutBucketOwnershipControlsCommand(input);
  * const response = await client.send(command);
@@ -105,6 +106,7 @@ export class PutBucketOwnershipControlsCommand extends $Command
       getSerdePlugin(config, this.serialize, this.deserialize),
       getEndpointPlugin(config, Command.getEndpointParameterInstructions()),
       getFlexibleChecksumsPlugin(config, {
+        requestAlgorithmMember: { httpHeader: "x-amz-sdk-checksum-algorithm", name: "ChecksumAlgorithm" },
         requestChecksumRequired: true,
       }),
     ];

clients/client-s3/src/models/models_0.ts

@@ -40,7 +40,7 @@ export type RequestCharged = (typeof RequestCharged)[keyof typeof RequestCharged
 export interface AbortMultipartUploadOutput {
   /**
    * <p>If present, indicates that the requester was successfully charged for the
-   *          request.</p>
+   *          request. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/RequesterPaysBuckets.html">Using Requester Pays buckets for storage transfers and usage</a> in the <i>Amazon Simple Storage Service user guide</i>.</p>
    *          <note>
    *             <p>This functionality is not supported for directory buckets.</p>
    *          </note>
@@ -559,7 +559,7 @@ export interface CompleteMultipartUploadOutput {
 
   /**
    * <p>If present, indicates that the requester was successfully charged for the
-   *          request.</p>
+   *          request. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/RequesterPaysBuckets.html">Using Requester Pays buckets for storage transfers and usage</a> in the <i>Amazon Simple Storage Service user guide</i>.</p>
    *          <note>
    *             <p>This functionality is not supported for directory buckets.</p>
    *          </note>
@@ -1006,7 +1006,7 @@ export interface CopyObjectOutput {
 
   /**
    * <p>If present, indicates that the requester was successfully charged for the
-   *          request.</p>
+   *          request. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/RequesterPaysBuckets.html">Using Requester Pays buckets for storage transfers and usage</a> in the <i>Amazon Simple Storage Service user guide</i>.</p>
    *          <note>
    *             <p>This functionality is not supported for directory buckets.</p>
    *          </note>
@@ -2140,8 +2140,8 @@ export interface CreateBucketConfiguration {
    * <p>Specifies the location where the bucket will be created.</p>
    *          <p>
    *             <b>Directory buckets </b> - The location type is Availability Zone or Local Zone.
-   *          To use the Local Zone location type, your account must be  enabled for Dedicated Local Zones. Otherwise, you get an HTTP <code>403 Forbidden</code> error with the
-   *          error code <code>AccessDenied</code>. To learn more, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/opt-in-directory-bucket-lz.html">Enable accounts for Dedicated Local Zones</a> in the <i>Amazon S3 User Guide</i>.
+   *          To use the Local Zone location type, your account must be  enabled for Local Zones. Otherwise, you get an HTTP <code>403 Forbidden</code> error with the
+   *          error code <code>AccessDenied</code>. To learn more, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/opt-in-directory-bucket-lz.html">Enable accounts for Local Zones</a> in the <i>Amazon S3 User Guide</i>.
    *       </p>
    *          <note>
    *             <p>This functionality is only supported by directory buckets.</p>
@@ -2497,7 +2497,7 @@ export interface CreateMultipartUploadOutput {
 
   /**
    * <p>If present, indicates that the requester was successfully charged for the
-   *          request.</p>
+   *          request. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/RequesterPaysBuckets.html">Using Requester Pays buckets for storage transfers and usage</a> in the <i>Amazon Simple Storage Service user guide</i>.</p>
    *          <note>
    *             <p>This functionality is not supported for directory buckets.</p>
    *          </note>
@@ -3677,7 +3677,7 @@ export interface DeleteObjectOutput {
 
   /**
    * <p>If present, indicates that the requester was successfully charged for the
-   *          request.</p>
+   *          request. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/RequesterPaysBuckets.html">Using Requester Pays buckets for storage transfers and usage</a> in the <i>Amazon Simple Storage Service user guide</i>.</p>
    *          <note>
    *             <p>This functionality is not supported for directory buckets.</p>
    *          </note>
@@ -5769,7 +5769,7 @@ export interface DeleteObjectsOutput {
 
   /**
    * <p>If present, indicates that the requester was successfully charged for the
-   *          request.</p>
+   *          request. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/RequesterPaysBuckets.html">Using Requester Pays buckets for storage transfers and usage</a> in the <i>Amazon Simple Storage Service user guide</i>.</p>
    *          <note>
    *             <p>This functionality is not supported for directory buckets.</p>
    *          </note>
@@ -6078,7 +6078,7 @@ export interface GetBucketAccelerateConfigurationOutput {
 
   /**
    * <p>If present, indicates that the requester was successfully charged for the
-   *          request.</p>
+   *          request. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/RequesterPaysBuckets.html">Using Requester Pays buckets for storage transfers and usage</a> in the <i>Amazon Simple Storage Service user guide</i>.</p>
    *          <note>
    *             <p>This functionality is not supported for directory buckets.</p>
    *          </note>
@@ -7509,8 +7509,8 @@ export interface LifecycleRule {
 
   /**
    * <p>The <code>Filter</code> is used to identify objects that a Lifecycle Rule applies to. A
-   *             <code>Filter</code> must have exactly one of <code>Prefix</code>, <code>Tag</code>, or
-   *             <code>And</code> specified. <code>Filter</code> is required if the
+   *          <code>Filter</code> must have exactly one of <code>Prefix</code>, <code>Tag</code>,
+   *          <code>ObjectSizeGreaterThan</code>, <code>ObjectSizeLessThan</code>, or <code>And</code> specified. <code>Filter</code> is required if the
    *             <code>LifecycleRule</code> does not contain a <code>Prefix</code> element.</p>
    *          <note>
    *             <p>
@@ -10040,7 +10040,7 @@ export interface GetObjectOutput {
 
   /**
    * <p>If present, indicates that the requester was successfully charged for the
-   *          request.</p>
+   *          request. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/RequesterPaysBuckets.html">Using Requester Pays buckets for storage transfers and usage</a> in the <i>Amazon Simple Storage Service user guide</i>.</p>
    *          <note>
    *             <p>This functionality is not supported for directory buckets.</p>
    *          </note>
@@ -10492,7 +10492,7 @@ export interface GetObjectAclOutput {
 
   /**
    * <p>If present, indicates that the requester was successfully charged for the
-   *          request.</p>
+   *          request. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/RequesterPaysBuckets.html">Using Requester Pays buckets for storage transfers and usage</a> in the <i>Amazon Simple Storage Service user guide</i>.</p>
    *          <note>
    *             <p>This functionality is not supported for directory buckets.</p>
    *          </note>
@@ -10762,7 +10762,7 @@ export interface GetObjectAttributesOutput {
 
   /**
    * <p>If present, indicates that the requester was successfully charged for the
-   *          request.</p>
+   *          request. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/RequesterPaysBuckets.html">Using Requester Pays buckets for storage transfers and usage</a> in the <i>Amazon Simple Storage Service user guide</i>.</p>
    *          <note>
    *             <p>This functionality is not supported for directory buckets.</p>
    *          </note>
@@ -10872,14 +10872,14 @@ export interface GetObjectAttributesRequest {
   VersionId?: string | undefined;
 
   /**
-   * <p>Sets the maximum number of parts to return.</p>
+   * <p>Sets the maximum number of parts to return. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/mpuoverview.html">Uploading and copying objects using multipart upload in Amazon S3 </a> in the <i>Amazon Simple Storage Service user guide</i>.</p>
    * @public
    */
   MaxParts?: number | undefined;
 
   /**
    * <p>Specifies the part after which listing should begin. Only parts with higher part numbers
-   *          will be listed.</p>
+   *          will be listed. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/mpuoverview.html">Uploading and copying objects using multipart upload in Amazon S3 </a> in the <i>Amazon Simple Storage Service user guide</i>.</p>
    * @public
    */
   PartNumberMarker?: string | undefined;
@@ -11309,7 +11309,7 @@ export interface GetObjectTorrentOutput {
 
   /**
    * <p>If present, indicates that the requester was successfully charged for the
-   *          request.</p>
+   *          request. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/RequesterPaysBuckets.html">Using Requester Pays buckets for storage transfers and usage</a> in the <i>Amazon Simple Storage Service user guide</i>.</p>
    *          <note>
    *             <p>This functionality is not supported for directory buckets.</p>
    *          </note>
@@ -11845,7 +11845,7 @@ export interface HeadObjectOutput {
 
   /**
    * <p>If present, indicates that the requester was successfully charged for the
-   *          request.</p>
+   *          request. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/RequesterPaysBuckets.html">Using Requester Pays buckets for storage transfers and usage</a> in the <i>Amazon Simple Storage Service user guide</i>.</p>
    *          <note>
    *             <p>This functionality is not supported for directory buckets.</p>
    *          </note>
@@ -12826,7 +12826,7 @@ export interface ListMultipartUploadsOutput {
 
   /**
    * <p>If present, indicates that the requester was successfully charged for the
-   *          request.</p>
+   *          request. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/RequesterPaysBuckets.html">Using Requester Pays buckets for storage transfers and usage</a> in the <i>Amazon Simple Storage Service user guide</i>.</p>
    *          <note>
    *             <p>This functionality is not supported for directory buckets.</p>
    *          </note>
@@ -13265,7 +13265,7 @@ export interface ListObjectsOutput {
 
   /**
    * <p>If present, indicates that the requester was successfully charged for the
-   *          request.</p>
+   *          request. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/RequesterPaysBuckets.html">Using Requester Pays buckets for storage transfers and usage</a> in the <i>Amazon Simple Storage Service user guide</i>.</p>
    *          <note>
    *             <p>This functionality is not supported for directory buckets.</p>
    *          </note>
@@ -13527,7 +13527,7 @@ export interface ListObjectsV2Output {
 
   /**
    * <p>If present, indicates that the requester was successfully charged for the
-   *          request.</p>
+   *          request. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/RequesterPaysBuckets.html">Using Requester Pays buckets for storage transfers and usage</a> in the <i>Amazon Simple Storage Service user guide</i>.</p>
    *          <note>
    *             <p>This functionality is not supported for directory buckets.</p>
    *          </note>
@@ -13915,7 +13915,7 @@ export interface ListObjectVersionsOutput {
 
   /**
    * <p>If present, indicates that the requester was successfully charged for the
-   *          request.</p>
+   *          request. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/RequesterPaysBuckets.html">Using Requester Pays buckets for storage transfers and usage</a> in the <i>Amazon Simple Storage Service user guide</i>.</p>
    *          <note>
    *             <p>This functionality is not supported for directory buckets.</p>
    *          </note>
@@ -14212,7 +14212,7 @@ export interface ListPartsOutput {
 
   /**
    * <p>If present, indicates that the requester was successfully charged for the
-   *          request.</p>
+   *          request. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/RequesterPaysBuckets.html">Using Requester Pays buckets for storage transfers and usage</a> in the <i>Amazon Simple Storage Service user guide</i>.</p>
    *          <note>
    *             <p>This functionality is not supported for directory buckets.</p>
    *          </note>