aws.s3.getObjects

Explore with Pulumi AI

AWS v6.83.0 published on Monday, Jun 16, 2025 by Pulumi

Using getObjects

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getObjects(args: GetObjectsArgs, opts?: InvokeOptions): Promise<GetObjectsResult>
function getObjectsOutput(args: GetObjectsOutputArgs, opts?: InvokeOptions): Output<GetObjectsResult>

def get_objects(bucket: Optional[str] = None,
                delimiter: Optional[str] = None,
                encoding_type: Optional[str] = None,
                fetch_owner: Optional[bool] = None,
                max_keys: Optional[int] = None,
                prefix: Optional[str] = None,
                request_payer: Optional[str] = None,
                start_after: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetObjectsResult
def get_objects_output(bucket: Optional[pulumi.Input[str]] = None,
                delimiter: Optional[pulumi.Input[str]] = None,
                encoding_type: Optional[pulumi.Input[str]] = None,
                fetch_owner: Optional[pulumi.Input[bool]] = None,
                max_keys: Optional[pulumi.Input[int]] = None,
                prefix: Optional[pulumi.Input[str]] = None,
                request_payer: Optional[pulumi.Input[str]] = None,
                start_after: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetObjectsResult]

func GetObjects(ctx *Context, args *GetObjectsArgs, opts ...InvokeOption) (*GetObjectsResult, error)
func GetObjectsOutput(ctx *Context, args *GetObjectsOutputArgs, opts ...InvokeOption) GetObjectsResultOutput

> Note: This function is named GetObjects in the Go SDK.

public static class GetObjects 
{
    public static Task<GetObjectsResult> InvokeAsync(GetObjectsArgs args, InvokeOptions? opts = null)
    public static Output<GetObjectsResult> Invoke(GetObjectsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetObjectsResult> getObjects(GetObjectsArgs args, InvokeOptions options)
public static Output<GetObjectsResult> getObjects(GetObjectsArgs args, InvokeOptions options)

fn::invoke:
  function: aws:s3/getObjects:getObjects
  arguments:
    # arguments dictionary

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: 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)
RequestPayer string: Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If included, the only valid value is requester.
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: 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)
RequestPayer string: Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If included, the only valid value is requester.
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: 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 Integer: Maximum object keys to return (Default: 1000)
prefix String: Limits results to object keys with this prefix (Default: none)
requestPayer String: Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If included, the only valid value is requester.
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: 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)
requestPayer string: Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If included, the only valid value is requester.
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: 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 int: Maximum object keys to return (Default: 1000)
prefix str: Limits results to object keys with this prefix (Default: none)
request_payer str: Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If included, the only valid value is requester.
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)

bucket String: Lists object keys in this S3 bucket. Alternatively, an S3 access point ARN can be specified
delimiter String: 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)
requestPayer String: Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If included, the only valid value is requester.
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)

getObjects 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)
RequestCharged string: If present, indicates that the requester was successfully charged for the request.
Delimiter string
EncodingType string
FetchOwner bool
MaxKeys int
Prefix string
RequestPayer 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)
RequestCharged string: If present, indicates that the requester was successfully charged for the request.
Delimiter string
EncodingType string
FetchOwner bool
MaxKeys int
Prefix string
RequestPayer string
StartAfter string

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)
requestCharged String: If present, indicates that the requester was successfully charged for the request.
delimiter String
encodingType String
fetchOwner Boolean
maxKeys Integer
prefix String
requestPayer 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)
requestCharged string: If present, indicates that the requester was successfully charged for the request.
delimiter string
encodingType string
fetchOwner boolean
maxKeys number
prefix string
requestPayer string
startAfter string

bucket str
common_prefixes Sequence[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 Sequence[str]: List of strings representing object keys
owners Sequence[str]: List of strings representing object owner IDs (see fetch_owner above)
request_charged str: If present, indicates that the requester was successfully charged for the request.
delimiter str
encoding_type str
fetch_owner bool
max_keys int
prefix str
request_payer str
start_after str

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)
requestCharged String: If present, indicates that the requester was successfully charged for the request.
delimiter String
encodingType String
fetchOwner Boolean
maxKeys Number
prefix String
requestPayer String
startAfter String

Package Details

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

AWS v6.83.0 published on Monday, Jun 16, 2025 by Pulumi

pulumi/pulumi-aws

aws.s3.getObjects

On this page

On this page

Using getObjects

getObjects Result

Package Details

On this page

On this page