Tagging

DELETE/?tagging

DeleteBucketTagging

Deletes the tags from the bucket.

Request Properties

  • Name
    Bucket
    Type
    string
    RequiredPath
    Description
  • Name
    x-amz-expected-bucket-owner
    Type
    string
    Header
    Description
    The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

Request

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

Response

HTTP/1.1 204
DELETE/:Key?tagging

DeleteObjectTagging

Removes the entire tag set from the specified object.

Request Properties

  • Name
    Bucket
    Type
    string
    RequiredPath
    Description
    The bucket name containing the objects from which to remove the tags.
  • Name
    Key
    Type
    string
    RequiredPath
    Description
    The key that identifies the object in the bucket from which to remove all tags.
  • Name
    x-amz-expected-bucket-owner
    Type
    string
    Not SupportedHeader
    Description
    The account ID of the expected bucket owner.
  • Name
    versionId
    Type
    string
    Query
    Description
    The versionId of the object that the tag-set will be removed from.

Response Properties

  • Name
    x-amz-version-id
    Type
    string
    Header
    Description
    The versionId of the object the tag-set was removed from.

Request

DELETE
/:Key?tagging
DELETE /{Key+}?tagging&versionId=VersionId HTTP/1.1
Host: Bucket.Endpoint
x-amz-expected-bucket-owner: ExpectedBucketOwner

Response

HTTP/1.1 204
x-amz-version-id: VersionId
GET/?tagging

GetBucketTagging

Returns the tag set associated with the bucket.

Request Properties

  • Name
    Bucket
    Type
    string
    SupportedRequiredPath
    Description
    The name of the bucket for which to get the tagging information.
  • Name
    x-amz-expected-bucket-owner
    Type
    string
    Not SupportedHeader
    Description
    The account ID of the expected bucket owner.

Response Properties

  • Name
    TagSet
    Type
    TagSet
    SupportedBody
    Description
    Contains the tag set.
  • Name
    Tagging
    Type
    Tagging
    SupportedBody
    Description
    Root level tag for the Tagging parameters.

Request

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

Response

HTTP/1.1 200
<?xml version="1.0" encoding="UTF-8"?>
<Tagging>
   <TagSet>
      <Tag>
         <Key>string</Key>
         <Value>string</Value>
      </Tag>
   </TagSet>
</Tagging>
GET/?tagging

GetBucketTagging

Returns the tag set associated with the bucket.

Request Properties

  • Name
    Bucket
    Type
    string
    SupportedRequiredPath
    Description
    The name of the bucket for which to get the tagging information.
  • Name
    x-amz-expected-bucket-owner
    Type
    string
    Not SupportedHeader
    Description
    The account ID of the expected bucket owner.

Response Properties

  • Name
    TagSet
    Type
    TagSet
    SupportedBody
    Description
    Contains the tag set.
  • Name
    Tagging
    Type
    Tagging
    SupportedBody
    Description
    Root level tag for the Tagging parameters.

Request

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

Response

HTTP/1.1 200
<?xml version="1.0" encoding="UTF-8"?>
<Tagging>
   <TagSet>
      <Tag>
         <Key>string</Key>
         <Value>string</Value>
      </Tag>
   </TagSet>
</Tagging>
GET/:Key?tagging

GetObjectTagging

Returns the tag-set of an object. You send the GET request against the tagging subresource associated with the object.

Request Properties

  • Name
    Bucket
    Type
    string
    SupportedRequiredPath
    Description
    The bucket name containing the object for which to get the tagging information.
  • Name
    Key
    Type
    string
    SupportedRequiredPath
    Description
    Object key for which to get the tagging information.
  • Name
    x-amz-expected-bucket-owner
    Type
    string
    Not SupportedHeader
    Description
    The account ID of the expected bucket owner.
  • Name
    x-amz-request-payer
    Type
    string
    Not SupportedHeader
    Description
    Confirms that the requester knows that they will be charged for the request.
  • Name
    VersionId
    Type
    string
    Not SupportedQuery
    Description
    The versionId of the object for which to get the tagging information.

Response Properties

  • Name
    x-amz-version-id
    Not SupportedHeader
    Description
    The versionId of the object for which you got the tagging information.
  • Name
    TagSet
    Type
    TagSet
    SupportedBody
    Description
    Contains the tag set.
  • Name
    Tagging
    Type
    Tagging
    SupportedBody
    Description
    Root level tag for the Tagging parameters.

Request

GET
/:Key?tagging
GET /{Key+}?tagging&versionId=VersionId HTTP/1.1
Host: Bucket.Endpoint
x-amz-expected-bucket-owner: ExpectedBucketOwner
x-amz-request-payer: RequestPayer

Response

HTTP/1.1 200
x-amz-version-id: VersionId
<?xml version="1.0" encoding="UTF-8"?>
<Tagging>
   <TagSet>
      <Tag>
         <Key>string</Key>
         <Value>string</Value>
      </Tag>
   </TagSet>
</Tagging>
PUT/?tagging

PutBucketTagging

Sets the tags for a bucket.

Request Properties

  • Name
    Bucket
    Type
    string
    SupportedRequiredPath
    Description
    The bucket name.
  • Name
    Content-MD5
    Type
    string
    SupportedHeader
    Description
    The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit.
  • Name
    x-amz-expected-bucket-owner
    Type
    string
    Not SupportedHeader
    Description
    The account ID of the expected bucket owner.
  • Name
    x-amz-sdk-checksum-algorithm
    Type
    string
    Not SupportedHeader
    Description
    Indicates the algorithm used to create the checksum for the object when you use the SDK.
  • Name
    TagSet
    Type
    TagSet
    SupportedRequiredBody
    Description
    A collection for a set of tags
  • Name
    Tagging
    Type
    Tagging
    SupportedRequiredBody
    Description
    Root level tag for the Tagging parameters.

Request

PUT
/?tagging
PUT /?tagging HTTP/1.1
Host: Bucket.Endpoint
Content-MD5: ContentMD5
x-amz-sdk-checksum-algorithm: ChecksumAlgorithm
x-amz-expected-bucket-owner: ExpectedBucketOwner
<?xml version="1.0" encoding="UTF-8"?>
<Tagging>
   <TagSet>
      <Tag>
         <Key>string</Key>
         <Value>string</Value>
      </Tag>
   </TagSet>
</Tagging>

Response

HTTP/1.1 200
PUT/:key?tagging

PutObjectTagging

Sets the supplied tag-set to an object that already exists in a bucket. A tag is a key-value pair.

Request Properties

  • Name
    Bucket
    Type
    string
    SupportedRequiredPath
    Description
    The bucket name containing the object.
  • Name
    Key
    Type
    string
    SupportedRequiredPath
    Description
    Name of the object key.
  • Name
    Content-MD5
    Type
    string
    SupportedHeader
    Description
    The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit.
  • Name
    x-amz-expected-bucket-owner
    Type
    string
    Not SupportedHeader
    Description
    The account ID of the expected bucket owner.
  • Name
    x-amz-request-payer
    Type
    string
    Not SupportedHeader
    Description
    Confirms that the requester knows that they will be charged for the request.
  • Name
    x-amz-sdk-checksum-algorithm
    Type
    string
    Not SupportedHeader
    Description
    Indicates the algorithm used to create the checksum for the object when you use the SDK.
  • Name
    VersionId
    Type
    string
    Not SupportedQuery
    Description
    The versionId of the object that the tag-set will be added to.
  • Name
    TagSet
    Type
    TagSet
    SupportedRequiredBody
    Description
    A collection for a set of tags
  • Name
    Tagging
    Type
    Tagging
    SupportedRequiredBody
    Description
    Root level tag for the Tagging parameters.

Response Properties

  • Name
    x-amz-version-id
    Type
    string
    Not SupportedHeader
    Description
    The versionId of the object the tag-set was added to.

Request

PUT
/:key?tagging
PUT /{Key+}?tagging&versionId=VersionId HTTP/1.1
Host: Bucket.Endpoint
Content-MD5: ContentMD5
x-amz-sdk-checksum-algorithm: ChecksumAlgorithm
x-amz-expected-bucket-owner: ExpectedBucketOwner
x-amz-request-payer: RequestPayer
<?xml version="1.0" encoding="UTF-8"?>
<Tagging>
   <TagSet>
      <Tag>
         <Key>string</Key>
         <Value>string</Value>
      </Tag>
   </TagSet>
</Tagging>

Response

HTTP/1.1 200
x-amz-version-id: VersionId