import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint"; import { Command as $Command } from "@aws-sdk/smithy-client"; import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types"; import { ListObjectsV2Output, ListObjectsV2Request } from "../models/models_0"; import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client"; /** * @public * * The input for {@link ListObjectsV2Command}. */ export interface ListObjectsV2CommandInput extends ListObjectsV2Request { } /** * @public * * The output of {@link ListObjectsV2Command}. */ export interface ListObjectsV2CommandOutput extends ListObjectsV2Output, __MetadataBearer { } /** * @public *
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
* 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.
* Objects are returned sorted in an ascending order of the respective key names in the list.
* For more information about listing objects, see Listing object keys
* programmatically
*
To use this operation, you must have READ access to the bucket.
*To use this action in an Identity and Access Management (IAM) policy, you must
* have permissions to perform the s3:ListBucket action. The bucket owner has
* this permission by default and can grant this permission to others. For more information
* about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3
* Resources.
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, ListObjects.
*To get a list of your buckets, see ListBuckets.
*The following operations are related to ListObjectsV2:
* GetObject *
** PutObject *
** CreateBucket *
*The specified bucket does not exist.
* * * @example To get object list * ```javascript * // The following example retrieves object list. The request specifies max keys to limit response to include only 2 object keys. * const input = { * "Bucket": "DOC-EXAMPLE-BUCKET", * "MaxKeys": "2" * }; * const command = new ListObjectsV2Command(input); * const response = await client.send(command); * /* response == * { * "Contents": [ * { * "ETag": "\"70ee1738b6b21e2c8a43f3a5ab0eee71\"", * "Key": "happyface.jpg", * "LastModified": "2014-11-21T19:40:05.000Z", * "Size": 11, * "StorageClass": "STANDARD" * }, * { * "ETag": "\"becf17f89c30367a9a44495d62ed521a-1\"", * "Key": "test.jpg", * "LastModified": "2014-05-02T04:51:50.000Z", * "Size": 4192256, * "StorageClass": "STANDARD" * } * ], * "IsTruncated": true, * "KeyCount": "2", * "MaxKeys": "2", * "Name": "DOC-EXAMPLE-BUCKET", * "NextContinuationToken": "1w41l63U0xa8q7smH50vCxyTQqdxo69O3EmK28Bi5PcROI4wI/EyIJg==", * "Prefix": "" * } * *\/ * // example id: to-get-object-list * ``` * */ export declare class ListObjectsV2Command extends $Command