Overview

This document provides an overview of APIs and SDK code samples related to inventory.

Setting Inventory Job

Feature description

This API (PUT Bucket inventory) is used to create an inventory job in a bucket.

Method prototype

put_bucket_inventory(Bucket, Id, InventoryConfiguration={}, **kwargs)

Sample request

response = client.put_bucket_inventory(
    Bucket='examplebucket-1250000000'',
    Id='string',
    InventoryConfiguration={
        'Destination': {
            'COSBucketDestination': {
                'AccountId': '100000000001',
                'Bucket': 'qcs::cos:ap-guangzhou::examplebucket-1250000000',
                'Format': 'CSV',
                'Prefix': 'string',
                'Encryption': {
                    'SSECOS': {}
                }
            }
        },
        'IsEnabled': 'true'|'false',
        'Filter': {
            'Prefix': 'string'
        },
        'IncludedObjectVersions':'All'|'Current',
        'OptionalFields': {
            'Field': [
                'Size',
                'LastModifiedDate',
                'ETag',
                'StorageClass',
                'IsMultipartUploaded',
                'ReplicationStatus'
            ]
        },
        'Schedule': {
            'Frequency': 'Daily'|'Weekly'
        }
    }
)

Parameter description

Returned result description

The returned value of this method is None.

Error code description

Some frequent special errors that may occur with this request are listed below:

Querying Inventory Job

Feature description

This API (GET Bucket inventory) is used to query the inventory job information in a bucket.

Method prototype

get_bucket_inventory(Bucket, Id, **kwargs)

Sample request

response = client.get_bucket_inventory(
    Bucket='examplebucket-1250000000',
    Id='string'
)

Parameter description

Returned result description

Inventory job configuration of the bucket in dict type.

{
    'Id': 'string',
    'Destination': {
        'COSBucketDestination': {
            'AccountId': '100000000001',
            'Bucket': 'qcs::cos:ap-guangzhou::examplebucket-1250000000',
            'Format': 'CSV',
            'Prefix': 'string',
            'Encryption': {
                'SSECOS': {}
            }
        }
    },
    'IsEnabled': 'true'|'false',
    'Filter': {
        'Prefix': 'string'
    },
    'IncludedObjectVersions':'All'|'Current',
    'OptionalFields': {
        'Field': [
            'Size',
            'LastModifiedDate',
            'ETag',
            'StorageClass',
            'IsMultipartUploaded',
            'ReplicationStatus'
        ]
    },
    'Schedule': {
        'Frequency': 'Daily'|'Weekly'
    }
}

Deleting Inventory Job

Feature description

This API (DELETE Bucket inventory) is used to delete a specified inventory job of a bucket.

Method prototype

delete_bucket_inventory(Bucket, Id, **kwargs)

Sample request

response = client.delete_bucket_inventory(
    Bucket='examplebucket-1250000000',
    Id='string'
)

Parameter description

Returned result description

The returned value of this method is None.