ListObjectsRequest

import type { ListObjectsRequest } from "https://aws-api.deno.dev/v0.4/services/s3.ts?docs=full";

interface ListObjectsRequest {

Bucket: string;

Delimiter?: string | null;

EncodingType?: EncodingType | null;

ExpectedBucketOwner?: string | null;

Marker?: string | null;

MaxKeys?: number | null;

Prefix?: string | null;

RequestPayer?: RequestPayer | null;

}

§Properties

Bucket: string

[src]

The name of the bucket containing the objects.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form _AccessPointName_-_AccountId_._outpostID_.s3-outposts._Region_.amazonaws.com. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

Delimiter?: string | null

[src]

A delimiter is a character you use to group keys.

EncodingType?: EncodingType | null

[src]

ExpectedBucketOwner?: string | null

[src]

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Marker?: string | null

[src]

Marker is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. Marker can be any key in the bucket.

MaxKeys?: number | null

[src]

Sets the maximum number of keys returned in the response. By default the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more.

Prefix?: string | null

[src]

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

RequestPayer?: RequestPayer | null

[src]

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.