Skip to content

List Tags for Resource

fsx_list_tags_for_resource R Documentation

Lists tags for Amazon FSx resources

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. list_tags_for_resource 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 MaxResults file system descriptions while still including a NextToken value.

  • The order of tags returned in the response of one list_tags_for_resource call and the order of tags returned across the responses of a multi-call iteration is unspecified.

Usage

fsx_list_tags_for_resource(ResourceARN, MaxResults, NextToken)

Arguments

ResourceARN

[required] The ARN of the Amazon FSx resource that will have its tags listed.

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.

NextToken

Opaque pagination token returned from a previous list_tags_for_resource operation (String). If a token present, the action continues the list from where the returning call left off.

Value

A list with the following syntax: 

list(
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_tags_for_resource(
  ResourceARN = "string",
  MaxResults = 123,
  NextToken = "string"
)

Examples

## Not run: 
# This operation lists tags for an Amazon FSx resource.
svc$list_tags_for_resource(
  ResourceARN = "arn:aws:fsx:us-east-1:012345678912:file-system/fs-0498eed5fe91001ec"
)

## End(Not run)