| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.FSx.ListTagsForResource
Description
Lists tags for Amazon FSx resources.
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 NextTokenvalue.
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
MaxResultsfile system descriptions while still including aNextTokenvalue. - The order of tags returned in the response of one
ListTagsForResourcecall and the order of tags returned across the responses of a multi-call iteration is unspecified.
This operation returns paginated results.
Synopsis
- data ListTagsForResource = ListTagsForResource' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- resourceARN :: Text
- newListTagsForResource :: Text -> ListTagsForResource
- listTagsForResource_maxResults :: Lens' ListTagsForResource (Maybe Natural)
- listTagsForResource_nextToken :: Lens' ListTagsForResource (Maybe Text)
- listTagsForResource_resourceARN :: Lens' ListTagsForResource Text
- data ListTagsForResourceResponse = ListTagsForResourceResponse' {}
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- listTagsForResourceResponse_nextToken :: Lens' ListTagsForResourceResponse (Maybe Text)
- listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (NonEmpty Tag))
- listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int
Creating a Request
data ListTagsForResource Source #
The request object for ListTagsForResource operation.
See: newListTagsForResource smart constructor.
Constructors
| ListTagsForResource' | |
Fields
| |
Instances
newListTagsForResource Source #
Arguments
| :: Text | |
| -> ListTagsForResource |
Create a value of ListTagsForResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListTagsForResource', listTagsForResource_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.
ListTagsForResource, listTagsForResource_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.
ListTagsForResource, listTagsForResource_resourceARN - The ARN of the Amazon FSx resource that will have its tags listed.
Request Lenses
listTagsForResource_maxResults :: Lens' ListTagsForResource (Maybe Natural) Source #
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.
listTagsForResource_nextToken :: Lens' ListTagsForResource (Maybe Text) Source #
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.
listTagsForResource_resourceARN :: Lens' ListTagsForResource Text Source #
The ARN of the Amazon FSx resource that will have its tags listed.
Destructuring the Response
data ListTagsForResourceResponse Source #
The response object for ListTagsForResource operation.
See: newListTagsForResourceResponse smart constructor.
Constructors
| ListTagsForResourceResponse' | |
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListTagsForResource, listTagsForResourceResponse_nextToken - This is present if there are more tags than returned in the response
(String). You can use the NextToken value in the later request to
fetch the tags.
ListTagsForResourceResponse, listTagsForResourceResponse_tags - A list of tags on the resource.
$sel:httpStatus:ListTagsForResourceResponse', listTagsForResourceResponse_httpStatus - The response's http status code.
Response Lenses
listTagsForResourceResponse_nextToken :: Lens' ListTagsForResourceResponse (Maybe Text) Source #
This is present if there are more tags than returned in the response
(String). You can use the NextToken value in the later request to
fetch the tags.
listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (NonEmpty Tag)) Source #
A list of tags on the resource.
listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int Source #
The response's http status code.