Bucket

PUT/

CreateBucket

This action creates a new bucket.

Request Properties

  • Name
    Bucket
    Type
    Bucket
    SupportedPath
    Description
    Specifies the information about the bucket that will be created.
  • Name
    x-amz-acl
    Type
    string
    Not SupportedHeader
    Description
    The canned ACL to apply to the bucket.
  • Name
    x-amz-bucket-object-lock-enabled
    Type
    string
    SupportedHeader
    Description
    Specifies whether you want S3 Object Lock to be enabled for the new bucket.
  • Name
    x-amz-grant-full-control
    Type
    string
    Not SupportedHeader
    Description
    Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.
  • Name
    x-amz-grant-read
    Type
    string
    Not SupportedHeader
    Description
    Allows grantee to list the objects in the bucket.
  • Name
    x-amz-grant-read-acp
    Type
    string
    Not SupportedHeader
    Description
    Allows grantee to read the bucket ACL.
  • Name
    x-amz-grant-write
    Type
    string
    Not SupportedHeader
    Description
    Allows grantee to create new objects in the bucket.\nFor the bucket and object owners of existing objects, also allows deletions and overwrites of those objects.
  • Name
    x-amz-grant-write-acp
    Type
    string
    Not SupportedHeader
    Description
    Allows grantee to write the ACL for the applicable bucket.
  • Name
    x-amz-object-ownership
    Type
    string
    Not SupportedHeader
    Description
    The container element for object ownership for a bucket's ownership controls.
  • Name
    CreateBucketConfiguration
    Type
    CreateBucketConfiguration
    Partially SupportedRequiredBody
    Description
    The configuration information for the bucket.
  • Name
    Location
    Type
    Location
    Not SupportedBody
    Description
    Specifies the location of the bucket.
  • Name
    LocationConstraint
    Type
    LocationConstraint
    SupportedBody
    Description
    Specifies the Anzen Location Configuration that the Bucket will use to store data.

Response Properties

  • Name
    Location
    Type
    string
    Header
    Description
    A forward slash followed by the name of the bucket.

Request

PUT
/
PUT / HTTP/1.1
Host: Bucket.Endpoint
x-amz-acl: ACL
x-amz-grant-full-control: GrantFullControl
x-amz-grant-read: GrantRead
x-amz-grant-read-acp: GrantReadACP
x-amz-grant-write: GrantWrite
x-amz-grant-write-acp: GrantWriteACP
x-amz-bucket-object-lock-enabled: ObjectLockEnabledForBucket
x-amz-object-ownership: ObjectOwnership
<?xml version="1.0" encoding="UTF-8"?>
<CreateBucketConfiguration>
<LocationConstraint>string</LocationConstraint>
<Location>
	<Name>string</Name>
	<Type>string</Type>
</Location>
<Bucket>
	<DataRedundancy>string</DataRedundancy>
	<Type>string</Type>
</Bucket>
</CreateBucketConfiguration>

Response

HTTP/1.1 200
Location: Location
DELETE/

DeleteBucket

Deletes the S3 bucket. All objects (including all object versions and delete markers) in the bucket must be deleted before the bucket itself can be deleted.

Request Properties

  • Name
    Bucket
    Type
    string
    SupportedRequiredPath
    Description
    Specifies the bucket being deleted.
  • Name
    x-amz-expected-bucket-owner
    Type
    string
    Not SupportedHeader
    Description
    The account ID of the expected bucket owner.

Request

DELETE
/
DELETE / HTTP/1.1
Host: Bucket.Endpoint
x-amz-expected-bucket-owner: ExpectedBucketOwner

Response

HTTP/1.1 204
GET/?location

GetBucketLocation

Returns the ID of the Location configuration that indicates where sharded data is being stored.

Request Properties

  • Name
    Bucket
    Type
    string
    SupportedRequiredPath
    Description
    Specifies the bucket being deleted.
  • Name
    x-amz-expected-bucket-owner
    Type
    string
    Not SupportedHeader
    Description
    The account ID of the expected bucket owner.

Response Properties

  • Name
    LocationConstraint
    Type
    string
    Body
    Description
    The unique identifier (ID) of the location configuration used to indicate storage locations for sharded data.

Request

GET
/?location
GET /?location HTTP/1.1
Host: Bucket.Endpoint
x-amz-expected-bucket-owner: ExpectedBucketOwner

Response

HTTP/1.1 200
<?xml version="1.0" encoding="UTF-8"?>
<LocationConstraint>
	string
</LocationConstraint>
HEAD/

HeadBucket

You can use this operation to determine if a bucket exists and if you have permission to access it. The action returns a 200 OK if the bucket exists and you have permission to access it.

Request Properties

  • Name
    Bucket
    Type
    string
    SupportedRequiredPath
    Description
    Specifies the bucket being deleted.
  • Name
    x-amz-expected-bucket-owner
    Type
    string
    Not SupportedHeader
    Description
    The account ID of the expected bucket owner.

Response Properties

  • Name
    x-amz-access-point-alias
    Type
    string
    Not SupportedHeader
    Description
    Indicates whether the bucket name used in the request is an access point alias.
  • Name
    x-amz-bucket-location-name
    Type
    string
    Not SupportedHeader
    Description
    The name of the location where the bucket will be created.
  • Name
    x-amz-bucket-location-type
    Type
    string
    Not SupportedHeader
    Description
    The type of location where the bucket is created.
  • Name
    x-amz-bucket-region
    Type
    string
    Not SupportedHeader
    Description
    The Region that the bucket is located.

Request

HEAD
/
HEAD / HTTP/1.1
Host: Bucket.Endpoint
x-amz-expected-bucket-owner: ExpectedBucketOwner

Response

HTTP/1.1 200
x-amz-bucket-location-type: BucketLocationType
x-amz-bucket-location-name: BucketLocationName
x-amz-bucket-region: BucketRegion
x-amz-access-point-alias: AccessPointAlias
GET/

ListBuckets

Returns a list of all buckets owned by the authenticated sender of the request.

Request Properties

  • Name
    continuation-token
    Type
    string
    Not SupportedQuery
    Description
    Specifies the bucket being deleted.
  • Name
    max-buckets
    Type
    string
    Not SupportedQuery
    Description
    Maximum number of buckets to be returned in response. When the number is more than the count of buckets that are owned by an AWS account, return all the buckets in response.

Response Properties

  • Name
    Buckets
    Type
    Buckets
    Body
    Description
    The list of buckets owned by the requester.
  • Name
    ContinuationToken
    Type
    string
    Not SupportedBody
    Description
  • Name
    ListAllMyBucketsResult
    Type
    ListAllMyBucketsResult
    Body
    Description
    Root level tag for the ListAllMyBucketsResult parameters.
  • Name
    Owner
    Type
    Owner
    Not SupportedBody
    Description
    The owner of the buckets listed.

Request

GET
/
GET /?continuation-token=ContinuationToken&max-buckets=MaxBuckets HTTP/1.1
Host: Bucket.Endpoint

Response

HTTP/1.1 200
<?xml version="1.0" encoding="UTF-8"?>
<ListAllMyBucketsResult>
<Buckets>
	<Bucket>
		<CreationDate>timestamp</CreationDate>
		<Name>string</Name>
	</Bucket>
</Buckets>
<Owner>
	<DisplayName>string</DisplayName>
	<ID>string</ID>
</Owner>
<ContinuationToken>string</ContinuationToken>
</ListAllMyBucketsResult>