volcenginecc.tos.getBucketInventory

volcenginecc v0.0.32, Apr 23 26

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Using getBucketInventory

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 getBucketInventory(args: GetBucketInventoryArgs, opts?: InvokeOptions): Promise<GetBucketInventoryResult>
function getBucketInventoryOutput(args: GetBucketInventoryOutputArgs, opts?: InvokeOptions): Output<GetBucketInventoryResult>

def get_bucket_inventory(id: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetBucketInventoryResult
def get_bucket_inventory_output(id: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetBucketInventoryResult]

func LookupBucketInventory(ctx *Context, args *LookupBucketInventoryArgs, opts ...InvokeOption) (*LookupBucketInventoryResult, error)
func LookupBucketInventoryOutput(ctx *Context, args *LookupBucketInventoryOutputArgs, opts ...InvokeOption) LookupBucketInventoryResultOutput

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

public static class GetBucketInventory 
{
    public static Task<GetBucketInventoryResult> InvokeAsync(GetBucketInventoryArgs args, InvokeOptions? opts = null)
    public static Output<GetBucketInventoryResult> Invoke(GetBucketInventoryInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetBucketInventoryResult> getBucketInventory(GetBucketInventoryArgs args, InvokeOptions options)
public static Output<GetBucketInventoryResult> getBucketInventory(GetBucketInventoryArgs args, InvokeOptions options)

fn::invoke:
  function: volcenginecc:tos/getBucketInventory:getBucketInventory
  arguments:
    # arguments dictionary

The following arguments are supported:

Id string: Uniquely identifies the resource.

Id string: Uniquely identifies the resource.

id String: Uniquely identifies the resource.

id string: Uniquely identifies the resource.

id str: Uniquely identifies the resource.

id String: Uniquely identifies the resource.

getBucketInventory Result

The following output properties are available:

BucketName string: Bucket name.
Destination Volcengine.GetBucketInventoryDestination: Information related to inventory files.
Filter Volcengine.GetBucketInventoryFilter: Prefix for filtering bucket inventory.
Id string: Uniquely identifies the resource.
IncludedObjectVersions string: Object version to export. Options: All: export information for all object versions. Current: export information for the current object version.
InventoryId string: Bucket inventory name, which must be globally unique within the current bucket. Details: Length must be 0–64 characters. Only lowercase letters a–z, uppercase letters A–Z, digits 0–9, hyphens (-), underscores (_), and periods (.) are allowed. The name must start and end with a lowercase letter a–z, uppercase letter A–Z, or digit 0–9.
IsEnabled bool: Whether to enable the bucket inventory feature. Options: true: enable; false: disable.
IsUnCompressed bool: Whether it is uncompressed.
OptionalFields Volcengine.GetBucketInventoryOptionalFields: Information about exported inventory files.
Schedule Volcengine.GetBucketInventorySchedule: Bucket inventory export frequency information.

BucketName string: Bucket name.
Destination GetBucketInventoryDestination: Information related to inventory files.
Filter GetBucketInventoryFilter: Prefix for filtering bucket inventory.
Id string: Uniquely identifies the resource.
IncludedObjectVersions string: Object version to export. Options: All: export information for all object versions. Current: export information for the current object version.
InventoryId string: Bucket inventory name, which must be globally unique within the current bucket. Details: Length must be 0–64 characters. Only lowercase letters a–z, uppercase letters A–Z, digits 0–9, hyphens (-), underscores (_), and periods (.) are allowed. The name must start and end with a lowercase letter a–z, uppercase letter A–Z, or digit 0–9.
IsEnabled bool: Whether to enable the bucket inventory feature. Options: true: enable; false: disable.
IsUnCompressed bool: Whether it is uncompressed.
OptionalFields GetBucketInventoryOptionalFields: Information about exported inventory files.
Schedule GetBucketInventorySchedule: Bucket inventory export frequency information.

bucketName String: Bucket name.
destination GetBucketInventoryDestination: Information related to inventory files.
filter GetBucketInventoryFilter: Prefix for filtering bucket inventory.
id String: Uniquely identifies the resource.
includedObjectVersions String: Object version to export. Options: All: export information for all object versions. Current: export information for the current object version.
inventoryId String: Bucket inventory name, which must be globally unique within the current bucket. Details: Length must be 0–64 characters. Only lowercase letters a–z, uppercase letters A–Z, digits 0–9, hyphens (-), underscores (_), and periods (.) are allowed. The name must start and end with a lowercase letter a–z, uppercase letter A–Z, or digit 0–9.
isEnabled Boolean: Whether to enable the bucket inventory feature. Options: true: enable; false: disable.
isUnCompressed Boolean: Whether it is uncompressed.
optionalFields GetBucketInventoryOptionalFields: Information about exported inventory files.
schedule GetBucketInventorySchedule: Bucket inventory export frequency information.

bucketName string: Bucket name.
destination GetBucketInventoryDestination: Information related to inventory files.
filter GetBucketInventoryFilter: Prefix for filtering bucket inventory.
id string: Uniquely identifies the resource.
includedObjectVersions string: Object version to export. Options: All: export information for all object versions. Current: export information for the current object version.
inventoryId string: Bucket inventory name, which must be globally unique within the current bucket. Details: Length must be 0–64 characters. Only lowercase letters a–z, uppercase letters A–Z, digits 0–9, hyphens (-), underscores (_), and periods (.) are allowed. The name must start and end with a lowercase letter a–z, uppercase letter A–Z, or digit 0–9.
isEnabled boolean: Whether to enable the bucket inventory feature. Options: true: enable; false: disable.
isUnCompressed boolean: Whether it is uncompressed.
optionalFields GetBucketInventoryOptionalFields: Information about exported inventory files.
schedule GetBucketInventorySchedule: Bucket inventory export frequency information.

bucket_name str: Bucket name.
destination GetBucketInventoryDestination: Information related to inventory files.
filter GetBucketInventoryFilter: Prefix for filtering bucket inventory.
id str: Uniquely identifies the resource.
included_object_versions str: Object version to export. Options: All: export information for all object versions. Current: export information for the current object version.
inventory_id str: Bucket inventory name, which must be globally unique within the current bucket. Details: Length must be 0–64 characters. Only lowercase letters a–z, uppercase letters A–Z, digits 0–9, hyphens (-), underscores (_), and periods (.) are allowed. The name must start and end with a lowercase letter a–z, uppercase letter A–Z, or digit 0–9.
is_enabled bool: Whether to enable the bucket inventory feature. Options: true: enable; false: disable.
is_un_compressed bool: Whether it is uncompressed.
optional_fields GetBucketInventoryOptionalFields: Information about exported inventory files.
schedule GetBucketInventorySchedule: Bucket inventory export frequency information.

bucketName String: Bucket name.
destination Property Map: Information related to inventory files.
filter Property Map: Prefix for filtering bucket inventory.
id String: Uniquely identifies the resource.
includedObjectVersions String: Object version to export. Options: All: export information for all object versions. Current: export information for the current object version.
inventoryId String: Bucket inventory name, which must be globally unique within the current bucket. Details: Length must be 0–64 characters. Only lowercase letters a–z, uppercase letters A–Z, digits 0–9, hyphens (-), underscores (_), and periods (.) are allowed. The name must start and end with a lowercase letter a–z, uppercase letter A–Z, or digit 0–9.
isEnabled Boolean: Whether to enable the bucket inventory feature. Options: true: enable; false: disable.
isUnCompressed Boolean: Whether it is uncompressed.
optionalFields Property Map: Information about exported inventory files.
schedule Property Map: Bucket inventory export frequency information.

Supporting Types

GetBucketInventoryDestination

TosBucketDestination Volcengine.GetBucketInventoryDestinationTosBucketDestination: Bucket information related to the inventory files.

TosBucketDestination GetBucketInventoryDestinationTosBucketDestination: Bucket information related to the inventory files.

tosBucketDestination GetBucketInventoryDestinationTosBucketDestination: Bucket information related to the inventory files.

tosBucketDestination GetBucketInventoryDestinationTosBucketDestination: Bucket information related to the inventory files.

tos_bucket_destination GetBucketInventoryDestinationTosBucketDestination: Bucket information related to the inventory files.

tosBucketDestination Property Map: Bucket information related to the inventory files.

GetBucketInventoryDestinationTosBucketDestination

AccountId string: Account ID of the bucket owner.
Bucket string: Specify the bucket to store the inventory files.
Format string: Inventory file format. Value is CSV, meaning the inventory file is in CSV format compressed with GZIP.
Prefix string: Prefix for the storage path of inventory files. By default, files are saved under tosbucketinventory/sourceBucketName/inventoryId/YYYY-MM-DDTHH-MMZ/files in the target bucket.
Role string: Role name used to grant permission to read all files from the source bucket and write files to the target bucket. The role must have TOS read/write and service access permissions. You can also use the default TOS role TosArchiveTOSInventory.

AccountId string: Account ID of the bucket owner.
Bucket string: Specify the bucket to store the inventory files.
Format string: Inventory file format. Value is CSV, meaning the inventory file is in CSV format compressed with GZIP.
Prefix string: Prefix for the storage path of inventory files. By default, files are saved under tosbucketinventory/sourceBucketName/inventoryId/YYYY-MM-DDTHH-MMZ/files in the target bucket.
Role string: Role name used to grant permission to read all files from the source bucket and write files to the target bucket. The role must have TOS read/write and service access permissions. You can also use the default TOS role TosArchiveTOSInventory.

accountId String: Account ID of the bucket owner.
bucket String: Specify the bucket to store the inventory files.
format String: Inventory file format. Value is CSV, meaning the inventory file is in CSV format compressed with GZIP.
prefix String: Prefix for the storage path of inventory files. By default, files are saved under tosbucketinventory/sourceBucketName/inventoryId/YYYY-MM-DDTHH-MMZ/files in the target bucket.
role String: Role name used to grant permission to read all files from the source bucket and write files to the target bucket. The role must have TOS read/write and service access permissions. You can also use the default TOS role TosArchiveTOSInventory.

accountId string: Account ID of the bucket owner.
bucket string: Specify the bucket to store the inventory files.
format string: Inventory file format. Value is CSV, meaning the inventory file is in CSV format compressed with GZIP.
prefix string: Prefix for the storage path of inventory files. By default, files are saved under tosbucketinventory/sourceBucketName/inventoryId/YYYY-MM-DDTHH-MMZ/files in the target bucket.
role string: Role name used to grant permission to read all files from the source bucket and write files to the target bucket. The role must have TOS read/write and service access permissions. You can also use the default TOS role TosArchiveTOSInventory.

account_id str: Account ID of the bucket owner.
bucket str: Specify the bucket to store the inventory files.
format str: Inventory file format. Value is CSV, meaning the inventory file is in CSV format compressed with GZIP.
prefix str: Prefix for the storage path of inventory files. By default, files are saved under tosbucketinventory/sourceBucketName/inventoryId/YYYY-MM-DDTHH-MMZ/files in the target bucket.
role str: Role name used to grant permission to read all files from the source bucket and write files to the target bucket. The role must have TOS read/write and service access permissions. You can also use the default TOS role TosArchiveTOSInventory.

accountId String: Account ID of the bucket owner.
bucket String: Specify the bucket to store the inventory files.
format String: Inventory file format. Value is CSV, meaning the inventory file is in CSV format compressed with GZIP.
prefix String: Prefix for the storage path of inventory files. By default, files are saved under tosbucketinventory/sourceBucketName/inventoryId/YYYY-MM-DDTHH-MMZ/files in the target bucket.
role String: Role name used to grant permission to read all files from the source bucket and write files to the target bucket. The role must have TOS read/write and service access permissions. You can also use the default TOS role TosArchiveTOSInventory.

GetBucketInventoryFilter

Prefix string: Prefix matching information for exported files. If not set, an inventory of all objects in the bucket is generated by default.

Prefix string: Prefix matching information for exported files. If not set, an inventory of all objects in the bucket is generated by default.

prefix String: Prefix matching information for exported files. If not set, an inventory of all objects in the bucket is generated by default.

prefix string: Prefix matching information for exported files. If not set, an inventory of all objects in the bucket is generated by default.

prefix str: Prefix matching information for exported files. If not set, an inventory of all objects in the bucket is generated by default.

prefix String: Prefix matching information for exported files. If not set, an inventory of all objects in the bucket is generated by default.

GetBucketInventoryOptionalFields

Fields List<string>: Information about exported inventory files.

Fields []string: Information about exported inventory files.

fields List<String>: Information about exported inventory files.

fields string[]: Information about exported inventory files.

fields Sequence[str]: Information about exported inventory files.

fields List<String>: Information about exported inventory files.

GetBucketInventorySchedule

Frequency string: Export frequency for inventory files. Options: Daily: export inventory files daily. Weekly: export inventory files weekly. Once: export inventory files once.

Frequency string: Export frequency for inventory files. Options: Daily: export inventory files daily. Weekly: export inventory files weekly. Once: export inventory files once.

frequency String: Export frequency for inventory files. Options: Daily: export inventory files daily. Weekly: export inventory files weekly. Once: export inventory files once.

frequency string: Export frequency for inventory files. Options: Daily: export inventory files daily. Weekly: export inventory files weekly. Once: export inventory files once.

frequency str: Export frequency for inventory files. Options: Daily: export inventory files daily. Weekly: export inventory files weekly. Once: export inventory files once.

frequency String: Export frequency for inventory files. Options: Daily: export inventory files daily. Weekly: export inventory files weekly. Once: export inventory files once.