S3Files / Paginator / ListTagsForResource
ListTagsForResource¶
- class S3Files.Paginator.ListTagsForResource¶
paginator = client.get_paginator('list_tags_for_resource')
- paginate(**kwargs)¶
Creates an iterator that will paginate through responses from
S3Files.Client.list_tags_for_resource().See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate( resourceId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } )
- Parameters:
resourceId (string) –
[REQUIRED]
The ID or Amazon Resource Name (ARN) of the resource to list tags for.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a
NextTokenwill be provided in the output that you can use to resume pagination.PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the
NextTokenfrom a previous response.
- Return type:
dict
- Returns:
Response Syntax
{ 'tags': [ { 'key': 'string', 'value': 'string' }, ], 'NextToken': 'string' }
Response Structure
(dict) –
tags (list) –
An array of tags associated with the resource.
(dict) –
A key-value pair for resource tagging.
key (string) –
The tag key. The key can’t start with
aws:.value (string) –
The tag value.
NextToken (string) –
A token to resume pagination.