pulumi-aws-kotlin/com.pulumi.aws.s3.kotlin/S3Functions/getObjects

getObjects

suspend fun getObjects(argument: GetObjectsPlainArgs): GetObjectsResult

NOTE on max_keys: Retrieving very large numbers of keys can adversely affect the provider's performance. The objects data source returns keys (i.e., file names) and other metadata about objects in an S3 bucket.

Return

A collection of values returned by getObjects.

Parameters

argument

A collection of arguments for invoking getObjects.

suspend fun getObjects(bucket: String, delimiter: String? = null, encodingType: String? = null, fetchOwner: Boolean? = null, maxKeys: Int? = null, prefix: String? = null, startAfter: String? = null): GetObjectsResult

Return

A collection of values returned by getObjects.

Parameters

bucket

Lists object keys in this S3 bucket. Alternatively, an S3 access point ARN can be specified

delimiter

Character used to group keys (Default: none)

encodingType

Encodes keys using this method (Default: none; besides none, only "url" can be used)

fetchOwner

Boolean specifying whether to populate the owner list (Default: false)

maxKeys

Maximum object keys to return (Default: 1000)

prefix

Limits results to object keys with this prefix (Default: none)

startAfter

Returns key names lexicographically after a specific object key in your bucket (Default: none; S3 lists object keys in UTF-8 character encoding in lexicographical order)

See also

.

suspend fun getObjects(argument: suspend GetObjectsPlainArgsBuilder.() -> Unit): GetObjectsResult

Return

A collection of values returned by getObjects.

Parameters

argument

Builder for com.pulumi.aws.s3.kotlin.inputs.GetObjectsPlainArgs.

See also

.