1. Docs
  2. Reference
  3. API
  4. AWS
  5. s3
  6. GetBucketObjects

GetBucketObjects

NOTE on max_keys: Retrieving very large numbers of keys can adversely affect this provider’s performance.

The bucket-objects data source returns keys (i.e., file names) and other metadata about objects in an S3 bucket.

Using GetBucketObjects

function getBucketObjects(args: GetBucketObjectsArgs, opts?: InvokeOptions): Promise<GetBucketObjectsResult>
function  get_bucket_objects(bucket=None, delimiter=None, encoding_type=None, fetch_owner=None, max_keys=None, prefix=None, start_after=None, opts=None)
func GetBucketObjects(ctx *Context, args *GetBucketObjectsArgs, opts ...InvokeOption) (*GetBucketObjectsResult, error)
public static class GetBucketObjects {
    public static Task<GetBucketObjectsResult> InvokeAsync(GetBucketObjectsArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

Bucket string

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

Delimiter string

A character used to group keys (Default: none)

EncodingType string

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

FetchOwner bool

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

MaxKeys int

Maximum object keys to return (Default: 1000)

Prefix string

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

StartAfter string

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)

Bucket string

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

Delimiter string

A character used to group keys (Default: none)

EncodingType string

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

FetchOwner bool

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

MaxKeys int

Maximum object keys to return (Default: 1000)

Prefix string

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

StartAfter string

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)

bucket string

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

delimiter string

A character used to group keys (Default: none)

encodingType string

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

fetchOwner boolean

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

maxKeys number

Maximum object keys to return (Default: 1000)

prefix string

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

startAfter string

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)

bucket str

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

delimiter str

A character used to group keys (Default: none)

encoding_type str

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

fetch_owner bool

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

max_keys float

Maximum object keys to return (Default: 1000)

prefix str

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

start_after str

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)

GetBucketObjects Result

The following output properties are available:

Bucket string
CommonPrefixes List<string>

List of any keys between prefix and the next occurrence of delimiter (i.e., similar to subdirectories of the prefix “directory”); the list is only returned when you specify delimiter

Id string

The provider-assigned unique ID for this managed resource.

Keys List<string>

List of strings representing object keys

Owners List<string>

List of strings representing object owner IDs (see fetch_owner above)

Delimiter string
EncodingType string
FetchOwner bool
MaxKeys int
Prefix string
StartAfter string
Bucket string
CommonPrefixes []string

List of any keys between prefix and the next occurrence of delimiter (i.e., similar to subdirectories of the prefix “directory”); the list is only returned when you specify delimiter

Id string

The provider-assigned unique ID for this managed resource.

Keys []string

List of strings representing object keys

Owners []string

List of strings representing object owner IDs (see fetch_owner above)

Delimiter string
EncodingType string
FetchOwner bool
MaxKeys int
Prefix string
StartAfter string
bucket string
commonPrefixes string[]

List of any keys between prefix and the next occurrence of delimiter (i.e., similar to subdirectories of the prefix “directory”); the list is only returned when you specify delimiter

id string

The provider-assigned unique ID for this managed resource.

keys string[]

List of strings representing object keys

owners string[]

List of strings representing object owner IDs (see fetch_owner above)

delimiter string
encodingType string
fetchOwner boolean
maxKeys number
prefix string
startAfter string
bucket str
common_prefixes List[str]

List of any keys between prefix and the next occurrence of delimiter (i.e., similar to subdirectories of the prefix “directory”); the list is only returned when you specify delimiter

id str

The provider-assigned unique ID for this managed resource.

keys List[str]

List of strings representing object keys

owners List[str]

List of strings representing object owner IDs (see fetch_owner above)

delimiter str
encoding_type str
fetch_owner bool
max_keys float
prefix str
start_after str

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.