IAM / Paginator / ListServerCertificateTags

ListServerCertificateTags

class IAM.Paginator.ListServerCertificateTags

paginator = client.get_paginator('list_server_certificate_tags')

paginate(**kwargs)

Creates an iterator that will paginate through responses from IAM.Client.list_server_certificate_tags().

See also: AWS API Documentation

Request Syntax

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

Parameters:

• ServerCertificateName (string) –

  [REQUIRED]

  The name of the IAM server certificate whose tags you want to see.

  This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

• 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

{
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    'IsTruncated': True|False,
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • Tags (list) –

    The list of tags that are currently attached to the IAM server certificate. Each tag consists of a key name and an associated value. If no tags are attached to the specified resource, the response contains an empty list.

    • (dict) –

      A structure that represents user-provided metadata that can be associated with an IAM resource. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

      • Key (string) –

        The key name that can be used to look up or retrieve the associated value. For example, Department or Cost Center are common choices.

      • Value (string) –

        The value associated with this tag. For example, tags with a key name of Department could have values such as Human Resources, Accounting, and Support. Tags with a key name of Cost Center might have values that consist of the number associated with the different cost centers in your company. Typically, many resources have tags with the same key name but with different values.

        Note

        Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.

  • IsTruncated (boolean) –

    A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

  • NextToken (string) –

    A token to resume pagination.