FSx / Client / list_tags_for_resource

list_tags_for_resource#

FSx.Client.list_tags_for_resource(**kwargs)#

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 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 a NextToken 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.

Request Syntax

response = client.list_tags_for_resource(
    ResourceARN='string',
    MaxResults=123,
    NextToken='string'
)

Parameters:

ResourceARN (string) –
[REQUIRED]

The ARN of the Amazon FSx resource that will have its tags listed.
MaxResults (integer) – 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 (string) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –

The response object for ListTagsForResource operation.
- Tags (list) –
  
  A list of tags on the resource.
  - (dict) –
    
    Specifies a key-value pair for a resource tag.
    - Key (string) –
      
      A value that specifies the TagKey, the name of the tag. Tag keys must be unique for the resource to which they are attached.
    - Value (string) –
      
      A value that specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and don’t have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April.
- NextToken (string) –
  
  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.

Exceptions

Examples

This operation lists tags for an Amazon FSx resource.

response = client.list_tags_for_resource(
    ResourceARN='arn:aws:fsx:us-east-1:012345678912:file-system/fs-0498eed5fe91001ec',
)

print(response)

Expected Output:

{
    'Tags': [
        {
            'Key': 'Name',
            'Value': 'MyFileSystem',
        },
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}