describeTags method
Returns a list of tags. You can return tags from a specific resource by specifying an ARN, or you can return all tags for a given type of resource, such as clusters, snapshots, and so on.
The following are limitations for DescribeTags
:
- You cannot specify an ARN and a resource-type value together in the same request.
-
You cannot use the
MaxRecords
andMarker
parameters together with the ARN parameter. -
The
MaxRecords
parameter can be a range from 10 to 50 results to return in a request.
owner
and
environment
for tag keys, and admin
and
test
for tag values, all resources that have any combination
of those values are returned.
If both tag keys and values are omitted from the request, resources are returned regardless of whether they have tag keys or values associated with them.
May throw ResourceNotFoundFault. May throw InvalidTagFault.
Parameter marker
:
A value that indicates the starting point for the next set of response
records in a subsequent request. If a value is returned in a response, you
can retrieve the next set of records by providing this returned marker
value in the marker
parameter and retrying the command. If
the marker
field is empty, all response records have been
retrieved for the request.
Parameter maxRecords
:
The maximum number or response records to return in each call. If the
number of remaining response records exceeds the specified
MaxRecords
value, a value is returned in a
marker
field of the response. You can retrieve the next set
of records by retrying the command with the returned marker
value.
Parameter resourceName
:
The Amazon Resource Name (ARN) for which you want to describe the tag or
tags. For example,
arn:aws:redshift:us-east-2:123456789:cluster:t1
.
Parameter resourceType
:
The type of resource with which you want to view tags. Valid resource
types are:
- Cluster
- CIDR/IP
- EC2 security group
- Snapshot
- Cluster security group
- Subnet group
- HSM connection
- HSM certificate
- Parameter group
- Snapshot copy grant
Parameter tagKeys
:
A tag key or keys for which you want to return all matching resources that
are associated with the specified key or keys. For example, suppose that
you have resources tagged with keys called owner
and
environment
. If you specify both of these tag keys in the
request, Amazon Redshift returns a response with all resources that have
either or both of these tag keys associated with them.
Parameter tagValues
:
A tag value or values for which you want to return all matching resources
that are associated with the specified value or values. For example,
suppose that you have resources tagged with values called
admin
and test
. If you specify both of these tag
values in the request, Amazon Redshift returns a response with all
resources that have either or both of these tag values associated with
them.
Implementation
Future<TaggedResourceListMessage> describeTags({
String? marker,
int? maxRecords,
String? resourceName,
String? resourceType,
List<String>? tagKeys,
List<String>? tagValues,
}) async {
_s.validateStringLength(
'marker',
marker,
0,
2147483647,
);
_s.validateStringLength(
'resourceName',
resourceName,
0,
2147483647,
);
_s.validateStringLength(
'resourceType',
resourceType,
0,
2147483647,
);
final $request = <String, dynamic>{};
marker?.also((arg) => $request['Marker'] = arg);
maxRecords?.also((arg) => $request['MaxRecords'] = arg);
resourceName?.also((arg) => $request['ResourceName'] = arg);
resourceType?.also((arg) => $request['ResourceType'] = arg);
tagKeys?.also((arg) => $request['TagKeys'] = arg);
tagValues?.also((arg) => $request['TagValues'] = arg);
final $result = await _protocol.send(
$request,
action: 'DescribeTags',
version: '2012-12-01',
method: 'POST',
requestUri: '/',
exceptionFnMap: _exceptionFns,
shape: shapes['DescribeTagsMessage'],
shapes: shapes,
resultWrapper: 'DescribeTagsResult',
);
return TaggedResourceListMessage.fromXml($result);
}