import { NodeHttpOptions as __HttpOptions__ } from "@aws-sdk/types"; import * as __aws_sdk_types from "@aws-sdk/types"; /** * ListObjectsInput shape */ export interface ListObjectsInput { /** * _BucketName shape */ Bucket: string; /** *

A delimiter is a character you use to group keys.

*/ Delimiter?: string; /** *

Requests Amazon S3 to encode the object keys in the response and specifies the encoding method to use. An object key may contain any Unicode character; however, XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response.

*/ EncodingType?: "url" | string; /** *

Specifies the key to start with when listing objects in a bucket.

*/ Marker?: string; /** *

Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more.

*/ MaxKeys?: number; /** *

Limits the response to keys that begin with the specified prefix.

*/ Prefix?: string; /** *

Confirms that the requester knows that she or he will be charged for the list objects request. Bucket owners need not specify this parameter in their requests.

*/ RequestPayer?: "requester" | string; /** * Whether to use the bucket name as the endpoint for this request. The bucket * name must be a domain name with a CNAME record alias to an appropriate virtual * hosted-style S3 hostname, e.g. a bucket of `images.johnsmith.net` and a DNS * record of: * * ``` * images.johnsmith.net CNAME images.johnsmith.net.s3.amazonaws.com. * ``` * * @see https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html#VirtualHostingCustomURLs */ $bucketEndpoint?: string; /** * Whether to force path style URLs for S3 objects (e.g., https://s3.amazonaws.com// instead of https://.s3.amazonaws.com/ */ $forcePathStyle?: boolean; /** * Whether to use the S3 Transfer Acceleration endpoint by default */ $useAccelerateEndpoint?: boolean; /** * Enables IPv6/IPv4 dualstack endpoint. When a DNS lookup is performed on an endpoint of this type, it returns an “A” record with an IPv4 address and an “AAAA” record with an IPv6 address. In most cases the network stack in the client environment will automatically prefer the AAAA record and make a connection using the IPv6 address. Note, however, that currently on Windows, the IPv4 address will be preferred. */ $useDualstackEndpoint?: boolean; /** * The maximum number of times this operation should be retried. If set, this value will override the `maxRetries` configuration set on the client for this command. */ $maxRetries?: number; /** * An object that may be queried to determine if the underlying operation has been aborted. * * @see https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal */ $abortSignal?: __aws_sdk_types.AbortSignal; /** * Per-request HTTP configuration options. If set, any options specified will override the corresponding HTTP option set on the client for this command. */ $httpOptions?: __HttpOptions__; }