@aws-sdk/client-s3 3.36.0 → 3.39.0

package/dist-types/ts3.4/commands/ListMultipartUploadsCommand.d.ts

@@ -6,79 +6,11 @@ export interface ListMultipartUploadsCommandInput extends ListMultipartUploadsRe
 }
 export interface ListMultipartUploadsCommandOutput extends ListMultipartUploadsOutput, __MetadataBearer {
 }
-/**
- * <p>This action lists in-progress multipart uploads. An in-progress multipart upload is a
- *          multipart upload that has been initiated using the Initiate Multipart Upload request, but
- *          has not yet been completed or aborted.</p>
- *
- *          <p>This action returns at most 1,000 multipart uploads in the response. 1,000 multipart
- *          uploads is the maximum number of uploads a response can include, which is also the default
- *          value. You can further limit the number of uploads in a response by specifying the
- *             <code>max-uploads</code> parameter in the response. If additional multipart uploads
- *          satisfy the list criteria, the response will contain an <code>IsTruncated</code> element
- *          with the value true. To list the additional multipart uploads, use the
- *             <code>key-marker</code> and <code>upload-id-marker</code> request parameters.</p>
- *
- *          <p>In the response, the uploads are sorted by key. If your application has initiated more
- *          than one multipart upload using the same object key, then uploads in the response are first
- *          sorted by key. Additionally, uploads are sorted in ascending order within each key by the
- *          upload initiation time.</p>
- *
- *          <p>For more information on multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html">Uploading Objects Using Multipart
- *             Upload</a>.</p>
- *
- *          <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
- *          Permissions</a>.</p>
- *
- *          <p>The following operations are related to <code>ListMultipartUploads</code>:</p>
- *          <ul>
- *             <li>
- *                <p>
- *                   <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html">CreateMultipartUpload</a>
- *                </p>
- *             </li>
- *             <li>
- *                <p>
- *                   <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html">UploadPart</a>
- *                </p>
- *             </li>
- *             <li>
- *                <p>
- *                   <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html">CompleteMultipartUpload</a>
- *                </p>
- *             </li>
- *             <li>
- *                <p>
- *                   <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html">ListParts</a>
- *                </p>
- *             </li>
- *             <li>
- *                <p>
- *                   <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html">AbortMultipartUpload</a>
- *                </p>
- *             </li>
- *          </ul>
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { S3Client, ListMultipartUploadsCommand } from "@aws-sdk/client-s3"; // ES Modules import
- * // const { S3Client, ListMultipartUploadsCommand } = require("@aws-sdk/client-s3"); // CommonJS import
- * const client = new S3Client(config);
- * const command = new ListMultipartUploadsCommand(input);
- * const response = await client.send(command);
- * ```
- *
- * @see {@link ListMultipartUploadsCommandInput} for command's `input` shape.
- * @see {@link ListMultipartUploadsCommandOutput} for command's `response` shape.
- * @see {@link S3ClientResolvedConfig | config} for command's `input` shape.
- *
- */
+
 export declare class ListMultipartUploadsCommand extends $Command<ListMultipartUploadsCommandInput, ListMultipartUploadsCommandOutput, S3ClientResolvedConfig> {
     readonly input: ListMultipartUploadsCommandInput;
     constructor(input: ListMultipartUploadsCommandInput);
-    /**
-     * @internal
-     */
+    
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListMultipartUploadsCommandInput, ListMultipartUploadsCommandOutput>;
     private serialize;
     private deserialize;

package/dist-types/ts3.4/commands/ListObjectVersionsCommand.d.ts

@@ -6,67 +6,11 @@ export interface ListObjectVersionsCommandInput extends ListObjectVersionsReques
 }
 export interface ListObjectVersionsCommandOutput extends ListObjectVersionsOutput, __MetadataBearer {
 }
-/**
- * <p>Returns metadata about all versions of the objects in a bucket. You can also use request
- *          parameters as selection criteria to return metadata about a subset of all the object
- *          versions.</p>
- *          <important>
- *             <p>
- *             To use this operation, you must have permissions to perform the
- *             <code>s3:ListBucketVersions</code> action. Be aware of the name difference.
- *          </p>
- *          </important>
- *          <note>
- *             <p> A 200 OK response can contain valid or invalid XML. Make sure to design your
- *             application to parse the contents of the response and handle it appropriately.</p>
- *          </note>
- *          <p>To use this operation, you must have READ access to the bucket.</p>
- *          <p>This action is not supported by Amazon S3 on Outposts.</p>
- *          <p>The following operations are related to
- *             <code>ListObjectVersions</code>:</p>
- *          <ul>
- *             <li>
- *                <p>
- *                   <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html">ListObjectsV2</a>
- *                </p>
- *             </li>
- *             <li>
- *                <p>
- *                   <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a>
- *                </p>
- *             </li>
- *             <li>
- *                <p>
- *                   <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html">PutObject</a>
- *                </p>
- *             </li>
- *             <li>
- *                <p>
- *                   <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html">DeleteObject</a>
- *                </p>
- *             </li>
- *          </ul>
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { S3Client, ListObjectVersionsCommand } from "@aws-sdk/client-s3"; // ES Modules import
- * // const { S3Client, ListObjectVersionsCommand } = require("@aws-sdk/client-s3"); // CommonJS import
- * const client = new S3Client(config);
- * const command = new ListObjectVersionsCommand(input);
- * const response = await client.send(command);
- * ```
- *
- * @see {@link ListObjectVersionsCommandInput} for command's `input` shape.
- * @see {@link ListObjectVersionsCommandOutput} for command's `response` shape.
- * @see {@link S3ClientResolvedConfig | config} for command's `input` shape.
- *
- */
+
 export declare class ListObjectVersionsCommand extends $Command<ListObjectVersionsCommandInput, ListObjectVersionsCommandOutput, S3ClientResolvedConfig> {
     readonly input: ListObjectVersionsCommandInput;
     constructor(input: ListObjectVersionsCommandInput);
-    /**
-     * @internal
-     */
+    
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListObjectVersionsCommandInput, ListObjectVersionsCommandOutput>;
     private serialize;
     private deserialize;

package/dist-types/ts3.4/commands/ListObjectsCommand.d.ts

@@ -6,66 +6,11 @@ export interface ListObjectsCommandInput extends ListObjectsRequest {
 }
 export interface ListObjectsCommandOutput extends ListObjectsOutput, __MetadataBearer {
 }
-/**
- * <p>Returns some or all (up to 1,000) of the objects in a bucket. You can use the request
- *          parameters as selection criteria to return a subset of the objects in a bucket. A 200 OK
- *          response can contain valid or invalid XML. Be sure to design your application to parse the
- *          contents of the response and handle it appropriately.</p>
- *          <important>
- *             <p>This action has been revised. We recommend that you use the newer version, <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html">ListObjectsV2</a>, when developing applications. For backward compatibility,
- *             Amazon S3 continues to support <code>ListObjects</code>.</p>
- *          </important>
- *
- *
- *          <p>The following operations are related to <code>ListObjects</code>:</p>
- *          <ul>
- *             <li>
- *                <p>
- *                   <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html">ListObjectsV2</a>
- *                </p>
- *             </li>
- *             <li>
- *                <p>
- *                   <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a>
- *                </p>
- *             </li>
- *             <li>
- *                <p>
- *                   <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html">PutObject</a>
- *                </p>
- *             </li>
- *             <li>
- *                <p>
- *                   <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a>
- *                </p>
- *             </li>
- *             <li>
- *                <p>
- *                   <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html">ListBuckets</a>
- *                </p>
- *             </li>
- *          </ul>
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { S3Client, ListObjectsCommand } from "@aws-sdk/client-s3"; // ES Modules import
- * // const { S3Client, ListObjectsCommand } = require("@aws-sdk/client-s3"); // CommonJS import
- * const client = new S3Client(config);
- * const command = new ListObjectsCommand(input);
- * const response = await client.send(command);
- * ```
- *
- * @see {@link ListObjectsCommandInput} for command's `input` shape.
- * @see {@link ListObjectsCommandOutput} for command's `response` shape.
- * @see {@link S3ClientResolvedConfig | config} for command's `input` shape.
- *
- */
+
 export declare class ListObjectsCommand extends $Command<ListObjectsCommandInput, ListObjectsCommandOutput, S3ClientResolvedConfig> {
     readonly input: ListObjectsCommandInput;
     constructor(input: ListObjectsCommandInput);
-    /**
-     * @internal
-     */
+    
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListObjectsCommandInput, ListObjectsCommandOutput>;
     private serialize;
     private deserialize;

package/dist-types/ts3.4/commands/ListObjectsV2Command.d.ts

@@ -6,70 +6,11 @@ export interface ListObjectsV2CommandInput extends ListObjectsV2Request {
 }
 export interface ListObjectsV2CommandOutput extends ListObjectsV2Output, __MetadataBearer {
 }
-/**
- * <p>Returns some or all (up to 1,000) of the objects in a bucket with each request. You can use
- *          the request parameters as selection criteria to return a subset of the objects in a bucket. A
- *          <code>200 OK</code> response can contain valid or invalid XML. Make sure to design your
- *          application to parse the contents of the response and handle it appropriately.
- *          Objects are returned sorted in an ascending order of the respective key names in the list.
- *          For more information about listing objects, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/ListingKeysUsingAPIs.html">Listing object keys
- *             programmatically</a>
- *          </p>
- *
- *          <p>To use this operation, you must have READ access to the bucket.</p>
- *
- *          <p>To use this action in an Identity and Access Management (IAM) policy, you must
- *          have permissions to perform the <code>s3:ListBucket</code> action. The bucket owner has
- *          this permission by default and 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
- *             Resources</a>.</p>
- *          <important>
- *             <p>This section describes the latest revision of this action. We recommend that you use this
- *             revised API for application development. For backward compatibility, Amazon S3 continues to
- *             support the prior version of this API, <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html">ListObjects</a>.</p>
- *          </important>
- *
- *          <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>
- *
- *          <p>The following operations are related to <code>ListObjectsV2</code>:</p>
- *          <ul>
- *             <li>
- *                <p>
- *                   <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a>
- *                </p>
- *             </li>
- *             <li>
- *                <p>
- *                   <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html">PutObject</a>
- *                </p>
- *             </li>
- *             <li>
- *                <p>
- *                   <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a>
- *                </p>
- *             </li>
- *          </ul>
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { S3Client, ListObjectsV2Command } from "@aws-sdk/client-s3"; // ES Modules import
- * // const { S3Client, ListObjectsV2Command } = require("@aws-sdk/client-s3"); // CommonJS import
- * const client = new S3Client(config);
- * const command = new ListObjectsV2Command(input);
- * const response = await client.send(command);
- * ```
- *
- * @see {@link ListObjectsV2CommandInput} for command's `input` shape.
- * @see {@link ListObjectsV2CommandOutput} for command's `response` shape.
- * @see {@link S3ClientResolvedConfig | config} for command's `input` shape.
- *
- */
+
 export declare class ListObjectsV2Command extends $Command<ListObjectsV2CommandInput, ListObjectsV2CommandOutput, S3ClientResolvedConfig> {
     readonly input: ListObjectsV2CommandInput;
     constructor(input: ListObjectsV2CommandInput);
-    /**
-     * @internal
-     */
+    
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListObjectsV2CommandInput, ListObjectsV2CommandOutput>;
     private serialize;
     private deserialize;

package/dist-types/ts3.4/commands/ListPartsCommand.d.ts

@@ -6,73 +6,11 @@ export interface ListPartsCommandInput extends ListPartsRequest {
 }
 export interface ListPartsCommandOutput extends ListPartsOutput, __MetadataBearer {
 }
-/**
- * <p>Lists the parts that have been uploaded for a specific multipart upload. This operation
- *          must include the upload ID, which you obtain by sending the initiate multipart upload
- *          request (see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html">CreateMultipartUpload</a>).
- *          This request returns a maximum of 1,000 uploaded parts. The default number of parts
- *          returned is 1,000 parts. You can restrict the number of parts returned by specifying the
- *             <code>max-parts</code> request parameter. If your multipart upload consists of more than
- *          1,000 parts, the response returns an <code>IsTruncated</code> field with the value of true,
- *          and a <code>NextPartNumberMarker</code> element. In subsequent <code>ListParts</code>
- *          requests you can include the part-number-marker query string parameter and set its value to
- *          the <code>NextPartNumberMarker</code> field value from the previous response.</p>
- *
- *          <p>For more information on multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html">Uploading Objects Using Multipart
- *             Upload</a>.</p>
- *
- *          <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
- *          Permissions</a>.</p>
- *
- *          <p>The following operations are related to <code>ListParts</code>:</p>
- *          <ul>
- *             <li>
- *                <p>
- *                   <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html">CreateMultipartUpload</a>
- *                </p>
- *             </li>
- *             <li>
- *                <p>
- *                   <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html">UploadPart</a>
- *                </p>
- *             </li>
- *             <li>
- *                <p>
- *                   <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html">CompleteMultipartUpload</a>
- *                </p>
- *             </li>
- *             <li>
- *                <p>
- *                   <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html">AbortMultipartUpload</a>
- *                </p>
- *             </li>
- *             <li>
- *                <p>
- *                   <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html">ListMultipartUploads</a>
- *                </p>
- *             </li>
- *          </ul>
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { S3Client, ListPartsCommand } from "@aws-sdk/client-s3"; // ES Modules import
- * // const { S3Client, ListPartsCommand } = require("@aws-sdk/client-s3"); // CommonJS import
- * const client = new S3Client(config);
- * const command = new ListPartsCommand(input);
- * const response = await client.send(command);
- * ```
- *
- * @see {@link ListPartsCommandInput} for command's `input` shape.
- * @see {@link ListPartsCommandOutput} for command's `response` shape.
- * @see {@link S3ClientResolvedConfig | config} for command's `input` shape.
- *
- */
+
 export declare class ListPartsCommand extends $Command<ListPartsCommandInput, ListPartsCommandOutput, S3ClientResolvedConfig> {
     readonly input: ListPartsCommandInput;
     constructor(input: ListPartsCommandInput);
-    /**
-     * @internal
-     */
+    
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListPartsCommandInput, ListPartsCommandOutput>;
     private serialize;
     private deserialize;

package/dist-types/ts3.4/commands/PutBucketAccelerateConfigurationCommand.d.ts

@@ -6,74 +6,11 @@ export interface PutBucketAccelerateConfigurationCommandInput extends PutBucketA
 }
 export interface PutBucketAccelerateConfigurationCommandOutput extends __MetadataBearer {
 }
-/**
- * <p>Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration is a
- *          bucket-level feature that enables you to perform faster data transfers to Amazon S3.</p>
- *
- *          <p> To use this operation, you must have permission to perform the
- *          s3:PutAccelerateConfiguration action. The bucket owner has this permission by default. The
- *          bucket owner 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
- *             Resources</a>.</p>
- *
- *          <p> The Transfer Acceleration state of a bucket can be set to one of the following two
- *          values:</p>
- *          <ul>
- *             <li>
- *                <p> Enabled – Enables accelerated data transfers to the bucket.</p>
- *             </li>
- *             <li>
- *                <p> Suspended – Disables accelerated data transfers to the bucket.</p>
- *             </li>
- *          </ul>
- *
- *
- *          <p>The <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAccelerateConfiguration.html">GetBucketAccelerateConfiguration</a> action returns the transfer acceleration
- *          state of a bucket.</p>
- *
- *          <p>After setting the Transfer Acceleration state of a bucket to Enabled, it might take up
- *          to thirty minutes before the data transfer rates to the bucket increase.</p>
- *
- *          <p> The name of the bucket used for Transfer Acceleration must be DNS-compliant and must
- *          not contain periods (".").</p>
- *
- *          <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>
- *
- *          <p>The following operations are related to
- *          <code>PutBucketAccelerateConfiguration</code>:</p>
- *          <ul>
- *             <li>
- *                <p>
- *                   <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAccelerateConfiguration.html">GetBucketAccelerateConfiguration</a>
- *                </p>
- *             </li>
- *             <li>
- *                <p>
- *                   <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a>
- *                </p>
- *             </li>
- *          </ul>
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { S3Client, PutBucketAccelerateConfigurationCommand } from "@aws-sdk/client-s3"; // ES Modules import
- * // const { S3Client, PutBucketAccelerateConfigurationCommand } = require("@aws-sdk/client-s3"); // CommonJS import
- * const client = new S3Client(config);
- * const command = new PutBucketAccelerateConfigurationCommand(input);
- * const response = await client.send(command);
- * ```
- *
- * @see {@link PutBucketAccelerateConfigurationCommandInput} for command's `input` shape.
- * @see {@link PutBucketAccelerateConfigurationCommandOutput} for command's `response` shape.
- * @see {@link S3ClientResolvedConfig | config} for command's `input` shape.
- *
- */
+
 export declare class PutBucketAccelerateConfigurationCommand extends $Command<PutBucketAccelerateConfigurationCommandInput, PutBucketAccelerateConfigurationCommandOutput, S3ClientResolvedConfig> {
     readonly input: PutBucketAccelerateConfigurationCommandInput;
     constructor(input: PutBucketAccelerateConfigurationCommandInput);
-    /**
-     * @internal
-     */
+    
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutBucketAccelerateConfigurationCommandInput, PutBucketAccelerateConfigurationCommandOutput>;
     private serialize;
     private deserialize;