Overview

This document provides an overview of APIs and SDK code samples related to basic bucket operations.

Querying bucket list

Feature

This API (GET Service) is used to query the list of all buckets in an account.

Method prototype

list_buckets()

Request samples

response = client.list_buckets(
)

Response

Query a bucket list in Dict format.

{
    'Buckets': {
        'Bucket': [
            {
                'Name': 'string',
                'Location': 'string',
                'CreationDate': 'string'
            },
        ],
    },
    'Owner': {
        'DisplayName': 'string',
        'ID': 'string'
    }
}

Creating a bucket

Feature

This API (PUT Bucket) is used to create a bucket under a specified account.

Method prototype

create_bucket(Bucket, **kwargs)

Request samples

response = client.create_bucket(
    Bucket='examplebucket-1250000000'
)

Sample request for all parameters

response = client.create_bucket(
    Bucket='examplebucket-1250000000',
    ACL='private'|'public-read'|'public-read-write',
    GrantFullControl='string',
    GrantRead='string',
    GrantWrite='string',    
)

Parameter description

Response

This method returns None.

Retrieving information on a bucket and its permission

Feature

This API (HEAD Bucket) is used to verify whether a bucket exists and if you have the permission to access it.

Method prototype

head_bucket(Bucket)

Request samples

response = client.head_bucket(
    Bucket='examplebucket-1250000000'
)

Parameter description

Response

This method returns None.

Deleting a bucket

Feature

This API (DELETE Bucket) is used to delete an empty bucket under a specified account.

Method prototype

delete_bucket(Bucket)

Request samples

response = client.delete_bucket(
    Bucket='examplebucket-1250000000'
)

Parameter description

Response

This method returns None.