listTagsForResource method
Lists tags for an Amazon FSx file systems and backups in the case of Amazon FSx for Windows File Server.
When retrieving all tags, you can optionally specify the
MaxResults
parameter to limit the number of tags in a
response. If more tags remain, Amazon FSx returns a NextToken
value in the response. In this case, send a later request with the
NextToken
request parameter set to the value of
NextToken
from the last response.
This action is used in an iterative process to retrieve a list of your
tags. ListTagsForResource
is called first without a
NextToken
value. Then the action continues to be called with
the NextToken
parameter set to the value of the last
NextToken
value until a response has no
NextToken
.
When using this action, keep the following in mind:
-
The implementation might return fewer than
MaxResults
file system descriptions while still including aNextToken
value. -
The order of tags returned in the response of one
ListTagsForResource
call and the order of tags returned across the responses of a multi-call iteration is unspecified.
May throw BadRequest. May throw InternalServerError. May throw ResourceNotFound. May throw NotServiceResourceError. May throw ResourceDoesNotSupportTagging.
Parameter resourceARN
:
The ARN of the Amazon FSx resource that will have its tags listed.
Parameter maxResults
:
Maximum number of tags to return in the response (integer). This parameter
value must be greater than 0. The number of items that Amazon FSx returns
is the minimum of the MaxResults
parameter specified in the
request and the service's internal maximum number of items per page.
Parameter nextToken
:
Opaque pagination token returned from a previous
ListTagsForResource
operation (String). If a token present,
the action continues the list from where the returning call left off.
Implementation
Future<ListTagsForResourceResponse> listTagsForResource({
required String resourceARN,
int? maxResults,
String? nextToken,
}) async {
ArgumentError.checkNotNull(resourceARN, 'resourceARN');
_s.validateStringLength(
'resourceARN',
resourceARN,
8,
512,
isRequired: true,
);
_s.validateNumRange(
'maxResults',
maxResults,
1,
2147483647,
);
_s.validateStringLength(
'nextToken',
nextToken,
1,
255,
);
final headers = <String, String>{
'Content-Type': 'application/x-amz-json-1.1',
'X-Amz-Target': 'AWSSimbaAPIService_v20180301.ListTagsForResource'
};
final jsonResponse = await _protocol.send(
method: 'POST',
requestUri: '/',
exceptionFnMap: _exceptionFns,
// TODO queryParams
headers: headers,
payload: {
'ResourceARN': resourceARN,
if (maxResults != null) 'MaxResults': maxResults,
if (nextToken != null) 'NextToken': nextToken,
},
);
return ListTagsForResourceResponse.fromJson(jsonResponse.body);
}