EFS / Paginator / DescribeTags

DescribeTags

class EFS.Paginator.DescribeTags

paginator = client.get_paginator('describe_tags')

paginate(**kwargs)

Creates an iterator that will paginate through responses from EFS.Client.describe_tags().

Danger

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    FileSystemId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• FileSystemId (string) –

  [REQUIRED]

  The ID of the file system whose tag set you want to retrieve.

• 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 NextToken will 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 NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

• (dict) –

  • Marker (string) –

    If the request included a Marker, the response returns that value in this field.

  • Tags (list) –

    Returns tags associated with the file system as an array of Tag objects.

    • (dict) –

      A tag is a key-value pair. Allowed characters are letters, white space, and numbers that can be represented in UTF-8, and the following characters: `` + - = . _ : /``.

      • Key (string) –

        The tag key (String). The key can’t start with aws:.

      • Value (string) –

        The value of the tag key.

  • NextToken (string) –

    A token to resume pagination.