1. Packages
  2. Volcengine
  3. API Docs
  4. tos
  5. getBucketObjects
Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

volcengine.tos.getBucketObjects

volcengine logo
Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

    Use this data source to query detailed information of tos objects

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as volcengine from "@pulumi/volcengine";

const default = volcengine.tos.getBucketObjects({
    bucketName: "test",
});

    import pulumi
import pulumi_volcengine as volcengine

default = volcengine.tos.get_bucket_objects(bucket_name="test")

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/tos"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := tos.GetBucketObjects(ctx, &tos.GetBucketObjectsArgs{
			BucketName: "test",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcengine = Pulumi.Volcengine;

return await Deployment.RunAsync(() => 
{
    var @default = Volcengine.Tos.GetBucketObjects.Invoke(new()
    {
        BucketName = "test",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.tos.TosFunctions;
import com.pulumi.volcengine.tos.inputs.GetBucketObjectsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var default = TosFunctions.getBucketObjects(GetBucketObjectsArgs.builder()
            .bucketName("test")
            .build());

    }
}

    variables:
  default:
    fn::invoke:
      Function: volcengine:tos:getBucketObjects
      Arguments:
        bucketName: test

    Using getBucketObjects

    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 getBucketObjects(args: GetBucketObjectsArgs, opts?: InvokeOptions): Promise<GetBucketObjectsResult>
function getBucketObjectsOutput(args: GetBucketObjectsOutputArgs, opts?: InvokeOptions): Output<GetBucketObjectsResult>
    def get_bucket_objects(bucket_name: Optional[str] = None,
                       name_regex: Optional[str] = None,
                       object_name: Optional[str] = None,
                       output_file: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetBucketObjectsResult
def get_bucket_objects_output(bucket_name: Optional[pulumi.Input[str]] = None,
                       name_regex: Optional[pulumi.Input[str]] = None,
                       object_name: Optional[pulumi.Input[str]] = None,
                       output_file: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetBucketObjectsResult]
    func GetBucketObjects(ctx *Context, args *GetBucketObjectsArgs, opts ...InvokeOption) (*GetBucketObjectsResult, error)
func GetBucketObjectsOutput(ctx *Context, args *GetBucketObjectsOutputArgs, opts ...InvokeOption) GetBucketObjectsResultOutput

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

    public static class GetBucketObjects 
{
    public static Task<GetBucketObjectsResult> InvokeAsync(GetBucketObjectsArgs args, InvokeOptions? opts = null)
    public static Output<GetBucketObjectsResult> Invoke(GetBucketObjectsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetBucketObjectsResult> getBucketObjects(GetBucketObjectsArgs args, InvokeOptions options)
public static Output<GetBucketObjectsResult> getBucketObjects(GetBucketObjectsArgs args, InvokeOptions options)

    fn::invoke:
  function: volcengine:tos/getBucketObjects:getBucketObjects
  arguments:
    # arguments dictionary

    The following arguments are supported:

    BucketName string
    The name the TOS bucket.
    NameRegex string
    A Name Regex of TOS Object.
    ObjectName string
    The name the TOS Object.
    OutputFile string
    File name where to save data source results.
    BucketName string
    The name the TOS bucket.
    NameRegex string
    A Name Regex of TOS Object.
    ObjectName string
    The name the TOS Object.
    OutputFile string
    File name where to save data source results.
    bucketName String
    The name the TOS bucket.
    nameRegex String
    A Name Regex of TOS Object.
    objectName String
    The name the TOS Object.
    outputFile String
    File name where to save data source results.
    bucketName string
    The name the TOS bucket.
    nameRegex string
    A Name Regex of TOS Object.
    objectName string
    The name the TOS Object.
    outputFile string
    File name where to save data source results.
    bucket_name str
    The name the TOS bucket.
    name_regex str
    A Name Regex of TOS Object.
    object_name str
    The name the TOS Object.
    output_file str
    File name where to save data source results.
    bucketName String
    The name the TOS bucket.
    nameRegex String
    A Name Regex of TOS Object.
    objectName String
    The name the TOS Object.
    outputFile String
    File name where to save data source results.

    getBucketObjects Result

    The following output properties are available:

    BucketName string
    Id string
    The provider-assigned unique ID for this managed resource.
    Objects List<GetBucketObjectsObject>
    The collection of TOS Object query.
    TotalCount int
    The total count of TOS Object query.
    NameRegex string
    ObjectName string
    OutputFile string
    BucketName string
    Id string
    The provider-assigned unique ID for this managed resource.
    Objects []GetBucketObjectsObject
    The collection of TOS Object query.
    TotalCount int
    The total count of TOS Object query.
    NameRegex string
    ObjectName string
    OutputFile string
    bucketName String
    id String
    The provider-assigned unique ID for this managed resource.
    objects List<GetBucketObjectsObject>
    The collection of TOS Object query.
    totalCount Integer
    The total count of TOS Object query.
    nameRegex String
    objectName String
    outputFile String
    bucketName string
    id string
    The provider-assigned unique ID for this managed resource.
    objects GetBucketObjectsObject[]
    The collection of TOS Object query.
    totalCount number
    The total count of TOS Object query.
    nameRegex string
    objectName string
    outputFile string
    bucket_name str
    id str
    The provider-assigned unique ID for this managed resource.
    objects Sequence[GetBucketObjectsObject]
    The collection of TOS Object query.
    total_count int
    The total count of TOS Object query.
    name_regex str
    object_name str
    output_file str
    bucketName String
    id String
    The provider-assigned unique ID for this managed resource.
    objects List<Property Map>
    The collection of TOS Object query.
    totalCount Number
    The total count of TOS Object query.
    nameRegex String
    objectName String
    outputFile String

    Supporting Types

    GetBucketObjectsObject

    Content string
    The content the TOS Object when content type is json or text and xml.
    Name string
    The name the TOS Object.
    Size int
    The name the TOS Object size.
    StorageClass string
    The name the TOS Object storage class.
    Content string
    The content the TOS Object when content type is json or text and xml.
    Name string
    The name the TOS Object.
    Size int
    The name the TOS Object size.
    StorageClass string
    The name the TOS Object storage class.
    content String
    The content the TOS Object when content type is json or text and xml.
    name String
    The name the TOS Object.
    size Integer
    The name the TOS Object size.
    storageClass String
    The name the TOS Object storage class.
    content string
    The content the TOS Object when content type is json or text and xml.
    name string
    The name the TOS Object.
    size number
    The name the TOS Object size.
    storageClass string
    The name the TOS Object storage class.
    content str
    The content the TOS Object when content type is json or text and xml.
    name str
    The name the TOS Object.
    size int
    The name the TOS Object size.
    storage_class str
    The name the TOS Object storage class.
    content String
    The content the TOS Object when content type is json or text and xml.
    name String
    The name the TOS Object.
    size Number
    The name the TOS Object size.
    storageClass String
    The name the TOS Object storage class.

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcengine
      Meet Neo: Your AI Platform Teammate