Actions on Buckets

Overview

This document provides an overview of APIs related to basic bucket operations and access control list (ACL) and corresponding SDK sample code.

Basic operations

ACL

Basic Operations

Querying Bucket List

Feature Description

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

Method Prototype

list_buckets()

Sample Request

response = client.list_buckets()

Return Result Descriptions

Bucket list in dict type.

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

Creating a Bucket

Feature Description

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

Method Prototype

create_bucket(Bucket, **kwargs)

Sample Request

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

Parameter Descriptions

Return Result Descriptions

The return value of this method is None.

Checking a Bucket and Its Permission

Feature Description

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

Method Prototype

head_bucket(Bucket)

Sample Request

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

Parameter Descriptions

Return Result Descriptions

The return value of this method is None.

Deleting a Bucket

Feature Description

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

Method Prototype

delete_bucket(Bucket)

Sample Request

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

Parameter Descriptions

Return Result Descriptions

The return value of this method is None.

ACL

Setting Bucket ACL

Feature Description

This API (PUT Bucket acl) is used to set the access control list (ACL) for the specified bucket.

Method Prototype

put_bucket_acl(Bucket, AccessControlPolicy={}, **kwargs)

Sample Request

response = client.put_bucket_acl(
    Bucket='examplebucket-1250000000',
    ACL='private'|'public-read'|'public-read-write',
    GrantFullControl='string',
    GrantRead='string',
    GrantWrite='string',
    AccessControlPolicy={
        'Grant': [
            {
                'Grantee': {
                    'DisplayName': 'string',
                    'Type': 'CanonicalUser'|'Group',
                    'ID': 'string',
                    'URI': 'string'
                },
                'Permission': 'FULL_CONTROL'|'WRITE'|'READ'
            },
        ],
        'Owner': {
            'DisplayName': 'string',
            'ID': 'string'
        }
    }
)

Parameter Descriptions

Return Result Descriptions

The return value of this method is None.

Querying Bucket ACL

Feature Description

This API (GET Bucket acl) is used to query the access control list (ACL) for the specified bucket.

Method Prototype

get_bucket_acl(Bucket, **kwargs)

Sample Request

response = client.get_bucket_acl(
    Bucket='examplebucket-1250000000',
)

Parameter Descriptions

Return Result Descriptions

Bucket ACL information in dict type.

{
    'Owner': {
        'DisplayName': 'string',
        'ID': 'string'
    },
    'Grant': [
        {
            'Grantee': {
                'DisplayName': 'string',
                'Type': 'CanonicalUser'|'Group',
                'ID': 'string',
                'URI': 'string'
            },
            'Permission': 'FULL_CONTROL'|'WRITE'|'READ'
        },
    ]
}