API- und AWS CLI Tag-Operationen verwenden
Verwenden Sie die folgenden Tag-Operationen, um Tags für eine Ressource hinzuzufügen, zu entfernen oder aufzulisten.
| API | CLI | Aktionsbeschreibung |
|---|---|---|
TagResource |
tag-resource |
Fügen Sie ein oder mehrere Tags für die Ressource hinzu, die den angegebenen ARN hat, oder überschreiben Sie diese. |
UntagResource |
untag-resource |
Löschen Sie ein oder mehrere Tags aus der Ressource, die den angegebenen ARN hat. |
ListTagsForResource |
list‑tags‑for‑resource |
Listen Sie ein oder mehrere Tags für die Ressource auf, die den angegebenen ARN hat. |
Tags beim Erstellen von einer Ressource hinzufügen
Wenn Sie beim Erstellen einer Arbeitsgruppe oder eines Datenkatalogs Tags hinzufügen möchten, verwenden Sie den tags-Parameter mit den CreateWorkGroup- oder CreateDataCatalog-API-Operationen oder mit den AWS CLI-Befehlen create-work-group oder create-data-catalog.
Tags mit API-Aktionen verwalten
Die folgenden Beispiele zeigen, wie Tag-API-Aktionen zum Verwalten von Tags auf Arbeitsgruppen und Datenkatalogen verwendet werden. Die Beispiele werden in der Programmiersprache Java gegeben.
Im folgenden Beispiel werden der Arbeitsgruppe zwei Tags hinzugefügt workgroupA:
List<Tag> tags = new ArrayList<>(); tags.add(new Tag().withKey("tagKey1").withValue("tagValue1")); tags.add(new Tag().withKey("tagKey2").withValue("tagValue2")); TagResourceRequest request = new TagResourceRequest() .withResourceARN("arn:aws:athena:us-east-1:123456789012:workgroup/workgroupA") .withTags(tags); client.tagResource(request);
Im folgenden Beispiel werden dem Datenkatalog zwei Tags hinzugefügt datacatalogA:
List<Tag> tags = new ArrayList<>(); tags.add(new Tag().withKey("tagKey1").withValue("tagValue1")); tags.add(new Tag().withKey("tagKey2").withValue("tagValue2")); TagResourceRequest request = new TagResourceRequest() .withResourceARN("arn:aws:athena:us-east-1:123456789012:datacatalog/datacatalogA") .withTags(tags); client.tagResource(request);
Anmerkung
Fügen Sie der gleichen Ressource keine doppelten Tag-Schlüssel hinzu. In diesem Fall gibt Athena eine Fehlermeldung aus. Wenn Sie eine Ressource mit einem vorhandenen Tag-Schlüssel in einer separaten TagResource-Aktion markieren, überschreibt der neue Tag-Wert den alten.
Im folgenden Beispiel wird tagKey2 aus der Arbeitsgruppe workgroupA entfernt:
List<String> tagKeys = new ArrayList<>(); tagKeys.add("tagKey2"); UntagResourceRequest request = new UntagResourceRequest() .withResourceARN("arn:aws:athena:us-east-1:123456789012:workgroup/workgroupA") .withTagKeys(tagKeys); client.untagResource(request);
Im folgenden Beispiel wird tagKey2 aus dem Datenkatalog datacatalogA entfernt:
List<String> tagKeys = new ArrayList<>(); tagKeys.add("tagKey2"); UntagResourceRequest request = new UntagResourceRequest() .withResourceARN("arn:aws:athena:us-east-1:123456789012:datacatalog/datacatalogA") .withTagKeys(tagKeys); client.untagResource(request);
Im folgenden Beispiel werden Tags für die Arbeitsgruppe aufgelistet workgroupA:
ListTagsForResourceRequest request = new ListTagsForResourceRequest() .withResourceARN("arn:aws:athena:us-east-1:123456789012:workgroup/workgroupA"); ListTagsForResourceResult result = client.listTagsForResource(request); List<Tag> resultTags = result.getTags();
Im folgenden Beispiel werden Tags für den Datenkatalog aufgelistet datacatalogA:
ListTagsForResourceRequest request = new ListTagsForResourceRequest() .withResourceARN("arn:aws:athena:us-east-1:123456789012:datacatalog/datacatalogA"); ListTagsForResourceResult result = client.listTagsForResource(request); List<Tag> resultTags = result.getTags();
Tags verwalten mit AWS CLI
In den folgenden Beispielen wird gezeigt, wie Sie mit AWS CLI Tags für Datenkataloge erstellen und verwalten.
Der tag-resource-Befehl fügt einzelne oder mehrere Tags einer angegebenen Ressource hinzu
Syntax
aws athena tag-resource --resource-arn
arn:aws:athena:region:account_id:datacatalog/catalog_name
--tags
Key=string,Value=string
Key=string,Value=string
Der --resource-arn-Parameter gibt die Ressource an, der die Tags hinzugefügt werden. Der --tags-Parameter gibt eine Liste von durch Leerzeichen getrennten Schlüssel-Wert-Paaren an, die der Ressource als Tags hinzugefügt werden sollen.
Beispiel
Im folgenden Beispiel werden dem mydatacatalog-Datenkatalog Tags hinzugefügt.
aws athena tag-resource --resource-arn arn:aws:athena:us-east-1:111122223333:datacatalog/mydatacatalog --tags Key=Color,Value=Orange Key=Time,Value=Now
Um das Ergebnis anzuzeigen, verwenden Sie den list-tags-for-resource-Befehl.
Weitere Informationen zum Hinzufügen von Tags bei Verwendung des create-data-catalog-Befehls finden Sie unter Registrierung eines Katalogs: Create-data-catalog.
Der list-tags-for-resource-Befehl listet die Tags für die angegebene Ressource auf.
Syntax
aws athena list-tags-for-resource --resource-arn
arn:aws:athena:region:account_id:datacatalog/catalog_name
Der --resource-arn-Parameter gibt die Ressource an, für die die Tags aufgelistet werden.
Im folgenden Beispiel werden die Tags für den mydatacatalog-Datenkatalog aufgelistet.
aws athena list-tags-for-resource --resource-arn arn:aws:athena:us-east-1:111122223333:datacatalog/mydatacatalog
Das folgende Beispielergebnis verwendet das JSON-Format.
{ "Tags": [ { "Key": "Time", "Value": "Now" }, { "Key": "Color", "Value": "Orange" } ] }
Der untag-resource-Befehl entfernt die angegebenen Tag-Schlüssel und die zugehörigen Werte von der angegebenen Ressource.
Syntax
aws athena untag-resource --resource-arn
arn:aws:athena:
region:account_id:datacatalog/catalog_name
--tag-keys key_name
[key_name ...]
Der --resource-arn-Parameter gibt die Ressource an, von der die Tags entfernt werden. Der --tag-keys-Parameter erstellt eine durch Leerzeichen getrennte Liste von Schlüsselnamen. Für jeden angegebenen Schlüsselnamen entfernt der untag-resource-Befehl sowohl den Schlüssel als auch seinen Wert.
Im folgenden Beispiel werden die Schlüssel Color und Time sowie deren Werte aus der mydatacatalog-Katalogressource entfernt.
aws athena untag-resource --resource-arn arn:aws:athena:us-east-1:111122223333:datacatalog/mydatacatalog --tag-keys Color Time
