Note
DEPRECATED - The DescribeTags
action is deprecated and not maintained. To view tags associated with EFS resources, use the ListTagsForResource
API action.
Returns the tags associated with a file system. The order of tags returned in the response of one DescribeTags
call and the order of tags returned across the responses of a multiple-call iteration (when using pagination) is unspecified.
This operation requires permissions for the elasticfilesystem:DescribeTags
action.
Danger
This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.
See also: AWS API Documentation
Request Syntax
response = client.describe_tags(
MaxItems=123,
Marker='string',
FileSystemId='string'
)
DescribeTags
operation (String). If present, it specifies to continue the list from where the previous call left off.[REQUIRED]
The ID of the file system whose tag set you want to retrieve.
dict
Response Syntax
{
'Marker': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'NextMarker': 'string'
}
Response Structure
(dict) --
Marker (string) --
If the request included a Marker
, the response returns that value in this field.
Tags (list) --
Returns tags associated with the file system as an array of Tag
objects.
(dict) --
A tag is a key-value pair. Allowed characters are letters, white space, and numbers that can be represented in UTF-8, and the following characters: + - = . _ : /
.
Key (string) --
The tag key (String). The key can't start with aws:
.
Value (string) --
The value of the tag key.
NextMarker (string) --
If a value is present, there are more tags to return. In a subsequent request, you can provide the value of NextMarker
as the value of the Marker
parameter in your next request to retrieve the next set of tags.
Exceptions
EFS.Client.exceptions.BadRequest
EFS.Client.exceptions.InternalServerError
EFS.Client.exceptions.FileSystemNotFound
Examples
This operation describes all of a file system's tags.
response = client.describe_tags(
FileSystemId='fs-01234567',
)
print(response)
Expected Output:
{
'Tags': [
{
'Key': 'Name',
'Value': 'MyFileSystem',
},
],
'ResponseMetadata': {
'...': '...',
},
}