@aws-sdk/client-s3 3.296.0 → 3.297.0

package/dist-types/commands/GetObjectRetentionCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { GetObjectRetentionOutput, GetObjectRetentionRequest } from "../models/models_0";
 import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
 /**
+ * @public
+ *
  * The input for {@link GetObjectRetentionCommand}.
  */
 export interface GetObjectRetentionCommandInput extends GetObjectRetentionRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link GetObjectRetentionCommand}.
  */
 export interface GetObjectRetentionCommandOutput extends GetObjectRetentionOutput, __MetadataBearer {
 }
 /**
+ * @public
  * <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>
  *          <p>This action is not supported by Amazon S3 on Outposts.</p>
  *          <p>The following action is related to <code>GetObjectRetention</code>:</p>
@@ -34,6 +39,8 @@ export interface GetObjectRetentionCommandOutput extends GetObjectRetentionOutpu
  * const response = await client.send(command);
  * ```
  *
+ * @param GetObjectRetentionCommandInput - {@link GetObjectRetentionCommandInput}
+ * @returns {@link GetObjectRetentionCommandOutput}
  * @see {@link GetObjectRetentionCommandInput} for command's `input` shape.
  * @see {@link GetObjectRetentionCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
@@ -43,11 +50,20 @@ export interface GetObjectRetentionCommandOutput extends GetObjectRetentionOutpu
 export declare class GetObjectRetentionCommand extends $Command<GetObjectRetentionCommandInput, GetObjectRetentionCommandOutput, S3ClientResolvedConfig> {
     readonly input: GetObjectRetentionCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: GetObjectRetentionCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetObjectRetentionCommandInput, GetObjectRetentionCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/GetObjectTaggingCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { GetObjectTaggingOutput, GetObjectTaggingRequest } from "../models/models_0";
 import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
 /**
+ * @public
+ *
  * The input for {@link GetObjectTaggingCommand}.
  */
 export interface GetObjectTaggingCommandInput extends GetObjectTaggingRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link GetObjectTaggingCommand}.
  */
 export interface GetObjectTaggingCommandOutput extends GetObjectTaggingOutput, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Returns the tag-set of an object. You send the GET request against the tagging
  *          subresource associated with the object.</p>
  *          <p>To use this operation, you must have permission to perform the
@@ -53,6 +58,8 @@ export interface GetObjectTaggingCommandOutput extends GetObjectTaggingOutput, _
  * const response = await client.send(command);
  * ```
  *
+ * @param GetObjectTaggingCommandInput - {@link GetObjectTaggingCommandInput}
+ * @returns {@link GetObjectTaggingCommandOutput}
  * @see {@link GetObjectTaggingCommandInput} for command's `input` shape.
  * @see {@link GetObjectTaggingCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
@@ -113,11 +120,20 @@ export interface GetObjectTaggingCommandOutput extends GetObjectTaggingOutput, _
 export declare class GetObjectTaggingCommand extends $Command<GetObjectTaggingCommandInput, GetObjectTaggingCommandOutput, S3ClientResolvedConfig> {
     readonly input: GetObjectTaggingCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: GetObjectTaggingCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetObjectTaggingCommandInput, GetObjectTaggingCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/GetObjectTorrentCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { GetObjectTorrentOutput, GetObjectTorrentRequest } from "../models/models_0";
 import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
 /**
+ * @public
+ *
  * The input for {@link GetObjectTorrentCommand}.
  */
 export interface GetObjectTorrentCommandInput extends GetObjectTorrentRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link GetObjectTorrentCommand}.
  */
 export interface GetObjectTorrentCommandOutput extends __WithSdkStreamMixin<GetObjectTorrentOutput, "Body">, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Returns torrent files from a bucket. BitTorrent can save you bandwidth when you're
  *          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>
  *          <note>
@@ -41,6 +46,8 @@ export interface GetObjectTorrentCommandOutput extends __WithSdkStreamMixin<GetO
  * const response = await client.send(command);
  * ```
  *
+ * @param GetObjectTorrentCommandInput - {@link GetObjectTorrentCommandInput}
+ * @returns {@link GetObjectTorrentCommandOutput}
  * @see {@link GetObjectTorrentCommandInput} for command's `input` shape.
  * @see {@link GetObjectTorrentCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
@@ -62,11 +69,20 @@ export interface GetObjectTorrentCommandOutput extends __WithSdkStreamMixin<GetO
 export declare class GetObjectTorrentCommand extends $Command<GetObjectTorrentCommandInput, GetObjectTorrentCommandOutput, S3ClientResolvedConfig> {
     readonly input: GetObjectTorrentCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: GetObjectTorrentCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetObjectTorrentCommandInput, GetObjectTorrentCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/GetPublicAccessBlockCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { GetPublicAccessBlockOutput, GetPublicAccessBlockRequest } from "../models/models_0";
 import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
 /**
+ * @public
+ *
  * The input for {@link GetPublicAccessBlockCommand}.
  */
 export interface GetPublicAccessBlockCommandInput extends GetPublicAccessBlockRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link GetPublicAccessBlockCommand}.
  */
 export interface GetPublicAccessBlockCommandOutput extends GetPublicAccessBlockOutput, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Retrieves the <code>PublicAccessBlock</code> configuration for an Amazon S3 bucket. To use
  *          this operation, you must have the <code>s3:GetBucketPublicAccessBlock</code> permission.
  *          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
@@ -61,6 +66,8 @@ export interface GetPublicAccessBlockCommandOutput extends GetPublicAccessBlockO
  * const response = await client.send(command);
  * ```
  *
+ * @param GetPublicAccessBlockCommandInput - {@link GetPublicAccessBlockCommandInput}
+ * @returns {@link GetPublicAccessBlockCommandOutput}
  * @see {@link GetPublicAccessBlockCommandInput} for command's `input` shape.
  * @see {@link GetPublicAccessBlockCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
@@ -70,11 +77,20 @@ export interface GetPublicAccessBlockCommandOutput extends GetPublicAccessBlockO
 export declare class GetPublicAccessBlockCommand extends $Command<GetPublicAccessBlockCommandInput, GetPublicAccessBlockCommandOutput, S3ClientResolvedConfig> {
     readonly input: GetPublicAccessBlockCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: GetPublicAccessBlockCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetPublicAccessBlockCommandInput, GetPublicAccessBlockCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/HeadBucketCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { HeadBucketRequest } from "../models/models_0";
 import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
 /**
+ * @public
+ *
  * The input for {@link HeadBucketCommand}.
  */
 export interface HeadBucketCommandInput extends HeadBucketRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link HeadBucketCommand}.
  */
 export interface HeadBucketCommandOutput extends __MetadataBearer {
 }
 /**
+ * @public
  * <p>This action is useful to determine if a bucket exists and you have permission to
  *          access it. The action returns a <code>200 OK</code> if the bucket exists and you have
  *          permission to access it.</p>
@@ -35,6 +40,8 @@ export interface HeadBucketCommandOutput extends __MetadataBearer {
  * const response = await client.send(command);
  * ```
  *
+ * @param HeadBucketCommandInput - {@link HeadBucketCommandInput}
+ * @returns {@link HeadBucketCommandOutput}
  * @see {@link HeadBucketCommandInput} for command's `input` shape.
  * @see {@link HeadBucketCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
@@ -58,11 +65,20 @@ export interface HeadBucketCommandOutput extends __MetadataBearer {
 export declare class HeadBucketCommand extends $Command<HeadBucketCommandInput, HeadBucketCommandOutput, S3ClientResolvedConfig> {
     readonly input: HeadBucketCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: HeadBucketCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<HeadBucketCommandInput, HeadBucketCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/HeadObjectCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { HeadObjectOutput, HeadObjectRequest } from "../models/models_0";
 import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
 /**
+ * @public
+ *
  * The input for {@link HeadObjectCommand}.
  */
 export interface HeadObjectCommandInput extends HeadObjectRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link HeadObjectCommand}.
  */
 export interface HeadObjectCommandOutput extends HeadObjectOutput, __MetadataBearer {
 }
 /**
+ * @public
  * <p>The HEAD action retrieves metadata from an object without returning the object
  *          itself. This action is useful if you're only interested in an object's metadata. To use
  *          HEAD, you must have READ access to the object.</p>
@@ -134,6 +139,8 @@ export interface HeadObjectCommandOutput extends HeadObjectOutput, __MetadataBea
  * const response = await client.send(command);
  * ```
  *
+ * @param HeadObjectCommandInput - {@link HeadObjectCommandInput}
+ * @returns {@link HeadObjectCommandOutput}
  * @see {@link HeadObjectCommandInput} for command's `input` shape.
  * @see {@link HeadObjectCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
@@ -169,11 +176,20 @@ export interface HeadObjectCommandOutput extends HeadObjectOutput, __MetadataBea
 export declare class HeadObjectCommand extends $Command<HeadObjectCommandInput, HeadObjectCommandOutput, S3ClientResolvedConfig> {
     readonly input: HeadObjectCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: HeadObjectCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<HeadObjectCommandInput, HeadObjectCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/ListBucketAnalyticsConfigurationsCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ListBucketAnalyticsConfigurationsOutput, ListBucketAnalyticsConfigurationsRequest } from "../models/models_0";
 import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
 /**
+ * @public
+ *
  * The input for {@link ListBucketAnalyticsConfigurationsCommand}.
  */
 export interface ListBucketAnalyticsConfigurationsCommandInput extends ListBucketAnalyticsConfigurationsRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link ListBucketAnalyticsConfigurationsCommand}.
  */
 export interface ListBucketAnalyticsConfigurationsCommandOutput extends ListBucketAnalyticsConfigurationsOutput, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Lists the analytics configurations for the bucket. You can have up to 1,000 analytics
  *          configurations per bucket.</p>
  *          <p>This action supports list pagination and does not return more than 100 configurations
@@ -60,6 +65,8 @@ export interface ListBucketAnalyticsConfigurationsCommandOutput extends ListBuck
  * const response = await client.send(command);
  * ```
  *
+ * @param ListBucketAnalyticsConfigurationsCommandInput - {@link ListBucketAnalyticsConfigurationsCommandInput}
+ * @returns {@link ListBucketAnalyticsConfigurationsCommandOutput}
  * @see {@link ListBucketAnalyticsConfigurationsCommandInput} for command's `input` shape.
  * @see {@link ListBucketAnalyticsConfigurationsCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
@@ -69,11 +76,20 @@ export interface ListBucketAnalyticsConfigurationsCommandOutput extends ListBuck
 export declare class ListBucketAnalyticsConfigurationsCommand extends $Command<ListBucketAnalyticsConfigurationsCommandInput, ListBucketAnalyticsConfigurationsCommandOutput, S3ClientResolvedConfig> {
     readonly input: ListBucketAnalyticsConfigurationsCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: ListBucketAnalyticsConfigurationsCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListBucketAnalyticsConfigurationsCommandInput, ListBucketAnalyticsConfigurationsCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/ListBucketIntelligentTieringConfigurationsCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ListBucketIntelligentTieringConfigurationsOutput, ListBucketIntelligentTieringConfigurationsRequest } from "../models/models_0";
 import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
 /**
+ * @public
+ *
  * The input for {@link ListBucketIntelligentTieringConfigurationsCommand}.
  */
 export interface ListBucketIntelligentTieringConfigurationsCommandInput extends ListBucketIntelligentTieringConfigurationsRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link ListBucketIntelligentTieringConfigurationsCommand}.
  */
 export interface ListBucketIntelligentTieringConfigurationsCommandOutput extends ListBucketIntelligentTieringConfigurationsOutput, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Lists the S3 Intelligent-Tiering configuration from the specified bucket.</p>
  *          <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>
  *          <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>
@@ -47,6 +52,8 @@ export interface ListBucketIntelligentTieringConfigurationsCommandOutput extends
  * const response = await client.send(command);
  * ```
  *
+ * @param ListBucketIntelligentTieringConfigurationsCommandInput - {@link ListBucketIntelligentTieringConfigurationsCommandInput}
+ * @returns {@link ListBucketIntelligentTieringConfigurationsCommandOutput}
  * @see {@link ListBucketIntelligentTieringConfigurationsCommandInput} for command's `input` shape.
  * @see {@link ListBucketIntelligentTieringConfigurationsCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
@@ -56,11 +63,20 @@ export interface ListBucketIntelligentTieringConfigurationsCommandOutput extends
 export declare class ListBucketIntelligentTieringConfigurationsCommand extends $Command<ListBucketIntelligentTieringConfigurationsCommandInput, ListBucketIntelligentTieringConfigurationsCommandOutput, S3ClientResolvedConfig> {
     readonly input: ListBucketIntelligentTieringConfigurationsCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: ListBucketIntelligentTieringConfigurationsCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListBucketIntelligentTieringConfigurationsCommandInput, ListBucketIntelligentTieringConfigurationsCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/ListBucketInventoryConfigurationsCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ListBucketInventoryConfigurationsOutput, ListBucketInventoryConfigurationsRequest } from "../models/models_0";
 import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
 /**
+ * @public
+ *
  * The input for {@link ListBucketInventoryConfigurationsCommand}.
  */
 export interface ListBucketInventoryConfigurationsCommandInput extends ListBucketInventoryConfigurationsRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link ListBucketInventoryConfigurationsCommand}.
  */
 export interface ListBucketInventoryConfigurationsCommandOutput extends ListBucketInventoryConfigurationsOutput, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Returns a list of inventory configurations for the bucket. You can have up to 1,000
  *          analytics configurations per bucket.</p>
  *          <p>This action supports list pagination and does not return more than 100 configurations
@@ -59,6 +64,8 @@ export interface ListBucketInventoryConfigurationsCommandOutput extends ListBuck
  * const response = await client.send(command);
  * ```
  *
+ * @param ListBucketInventoryConfigurationsCommandInput - {@link ListBucketInventoryConfigurationsCommandInput}
+ * @returns {@link ListBucketInventoryConfigurationsCommandOutput}
  * @see {@link ListBucketInventoryConfigurationsCommandInput} for command's `input` shape.
  * @see {@link ListBucketInventoryConfigurationsCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
@@ -68,11 +75,20 @@ export interface ListBucketInventoryConfigurationsCommandOutput extends ListBuck
 export declare class ListBucketInventoryConfigurationsCommand extends $Command<ListBucketInventoryConfigurationsCommandInput, ListBucketInventoryConfigurationsCommandOutput, S3ClientResolvedConfig> {
     readonly input: ListBucketInventoryConfigurationsCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: ListBucketInventoryConfigurationsCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListBucketInventoryConfigurationsCommandInput, ListBucketInventoryConfigurationsCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/ListBucketMetricsConfigurationsCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ListBucketMetricsConfigurationsOutput, ListBucketMetricsConfigurationsRequest } from "../models/models_0";
 import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
 /**
+ * @public
+ *
  * The input for {@link ListBucketMetricsConfigurationsCommand}.
  */
 export interface ListBucketMetricsConfigurationsCommandInput extends ListBucketMetricsConfigurationsRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link ListBucketMetricsConfigurationsCommand}.
  */
 export interface ListBucketMetricsConfigurationsCommandOutput extends ListBucketMetricsConfigurationsOutput, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Lists the metrics configurations for the bucket. The metrics configurations are only for
  *          the request metrics of the bucket and do not provide information on daily storage metrics.
  *          You can have up to 1,000 configurations per bucket.</p>
@@ -61,6 +66,8 @@ export interface ListBucketMetricsConfigurationsCommandOutput extends ListBucket
  * const response = await client.send(command);
  * ```
  *
+ * @param ListBucketMetricsConfigurationsCommandInput - {@link ListBucketMetricsConfigurationsCommandInput}
+ * @returns {@link ListBucketMetricsConfigurationsCommandOutput}
  * @see {@link ListBucketMetricsConfigurationsCommandInput} for command's `input` shape.
  * @see {@link ListBucketMetricsConfigurationsCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
@@ -70,11 +77,20 @@ export interface ListBucketMetricsConfigurationsCommandOutput extends ListBucket
 export declare class ListBucketMetricsConfigurationsCommand extends $Command<ListBucketMetricsConfigurationsCommandInput, ListBucketMetricsConfigurationsCommandOutput, S3ClientResolvedConfig> {
     readonly input: ListBucketMetricsConfigurationsCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: ListBucketMetricsConfigurationsCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListBucketMetricsConfigurationsCommandInput, ListBucketMetricsConfigurationsCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/ListBucketsCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ListBucketsOutput } from "../models/models_0";
 import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
 /**
+ * @public
+ *
  * The input for {@link ListBucketsCommand}.
  */
 export interface ListBucketsCommandInput {
 }
 /**
+ * @public
+ *
  * The output of {@link ListBucketsCommand}.
  */
 export interface ListBucketsCommandOutput extends ListBucketsOutput, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Returns a list of all buckets owned by the authenticated sender of the request. To use
  *         this operation, you must have the <code>s3:ListAllMyBuckets</code> permission.</p>
  * @example
@@ -26,6 +31,8 @@ export interface ListBucketsCommandOutput extends ListBucketsOutput, __MetadataB
  * const response = await client.send(command);
  * ```
  *
+ * @param ListBucketsCommandInput - {@link ListBucketsCommandInput}
+ * @returns {@link ListBucketsCommandOutput}
  * @see {@link ListBucketsCommandInput} for command's `input` shape.
  * @see {@link ListBucketsCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
@@ -66,11 +73,20 @@ export interface ListBucketsCommandOutput extends ListBucketsOutput, __MetadataB
 export declare class ListBucketsCommand extends $Command<ListBucketsCommandInput, ListBucketsCommandOutput, S3ClientResolvedConfig> {
     readonly input: ListBucketsCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: ListBucketsCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListBucketsCommandInput, ListBucketsCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ListMultipartUploadsOutput, ListMultipartUploadsRequest } from "../models/models_0";
 import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
 /**
+ * @public
+ *
  * The input for {@link ListMultipartUploadsCommand}.
  */
 export interface ListMultipartUploadsCommandInput extends ListMultipartUploadsRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link ListMultipartUploadsCommand}.
  */
 export interface ListMultipartUploadsCommandOutput extends ListMultipartUploadsOutput, __MetadataBearer {
 }
 /**
+ * @public
  * <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>
@@ -70,6 +75,8 @@ export interface ListMultipartUploadsCommandOutput extends ListMultipartUploadsO
  * const response = await client.send(command);
  * ```
  *
+ * @param ListMultipartUploadsCommandInput - {@link ListMultipartUploadsCommandInput}
+ * @returns {@link ListMultipartUploadsCommandOutput}
  * @see {@link ListMultipartUploadsCommandInput} for command's `input` shape.
  * @see {@link ListMultipartUploadsCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
@@ -179,11 +186,20 @@ export interface ListMultipartUploadsCommandOutput extends ListMultipartUploadsO
 export declare class ListMultipartUploadsCommand extends $Command<ListMultipartUploadsCommandInput, ListMultipartUploadsCommandOutput, S3ClientResolvedConfig> {
     readonly input: ListMultipartUploadsCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: ListMultipartUploadsCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListMultipartUploadsCommandInput, ListMultipartUploadsCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }