Tags - Amazon Macie

Tags

A tag is a label that you optionally define and associate with AWS resources, including certain types of Amazon Macie resources. Tags can help you identify, organize, and manage resources in different ways, such as by purpose, owner, environment, or other criteria. You can associate tags with the following types of Amazon Macie resources:

  • Classification jobs

  • Custom data identifiers

  • Findings filters

  • Member accounts

A resource can have as many as 50 tags. Each tag consists of a tag key and an associated tag value, both of which you define. A tag key is a general label that acts as a category for more specific tag values. A tag value acts as a descriptor for a tag key. For example, you might assign an Owner tag key to each classification job for your organization. The value for the key might be the name of the person or team to contact about the classification job.

You can use the Tags resource to add, retrieve, update, or remove tags from a classification job, custom data identifier, findings filter, or member account.

URI

/tags/resourceArn

HTTP Methods

GET

Operation ID: ListTagsForResource

Retrieves the tags (keys and values) that are associated with a classification job, custom data identifier, findings filter, or member account.

Path Parameters
Name Type Required Description
resourceArn String True

The Amazon Resource Name (ARN) of the classification job, custom data identifier, findings filter, or member account.

Responses
Status Code Response Model Description
200 ListTagsForResourceResponse

The request succeeded.

POST

Operation ID: TagResource

Adds or updates one or more tags (keys and values) that are associated with a classification job, custom data identifier, findings filter, or member account.

Path Parameters
Name Type Required Description
resourceArn String True

The Amazon Resource Name (ARN) of the classification job, custom data identifier, findings filter, or member account.

Responses
Status Code Response Model Description
204 TagResourceResponse

The request succeeded and there isn't any content to include in the body of the response (No Content).

DELETE

Operation ID: UntagResource

Removes one or more tags (keys and values) from a classification job, custom data identifier, findings filter, or member account.

Path Parameters
Name Type Required Description
resourceArn String True

The Amazon Resource Name (ARN) of the classification job, custom data identifier, findings filter, or member account.

Query Parameters
Name Type Required Description
tagKeys String True

The key of the tag to remove from the resource. To remove multiple tags, append the tagKeys parameter and argument for each additional tag to remove, separated by an ampersand (&).

Responses
Status Code Response Model Description
204 UntagResourceResponse

The request succeeded and there isn't any content to include in the body of the response (No Content).

Schemas

Request Bodies

Example POST

{ "tags": { } }

Response Bodies

Example ListTagsForResourceResponse

{ "tags": { } }

Example TagResourceResponse

{ }

Example UntagResourceResponse

{ }

Properties

ListTagsForResourceResponse

Provides information about the tags (keys and values) that are associated with a classification job, custom data identifier, findings filter, or member account.

Property Type Required Description
tags

TagMap

False

A map of key-value pairs that identifies the tags (keys and values) that are associated with the resource.

TagMap

A string-to-string map of key-value pairs that specifies the tags (keys and values) for a classification job, custom data identifier, findings filter, or member account.

Property Type Required Description

*

string

False

TagResourceRequest

Specifies the tags (keys and values) to associate with a classification job, custom data identifier, findings filter, or member account.

Property Type Required Description
tags

TagMap

True

A map of key-value pairs that specifies the tags to associate with the resource.

A resource can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

TagResourceResponse

The request succeeded. The specified tags were added to the resource.

UntagResourceResponse

The request succeeded. The specified tags were removed from the resource.

See Also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

ListTagsForResource

TagResource

UntagResource