ivsrealtime / Paginator / ListPublicKeys

ListPublicKeys

class ivsrealtime.Paginator.ListPublicKeys

paginator = client.get_paginator('list_public_keys')

paginate(**kwargs)

Creates an iterator that will paginate through responses from ivsrealtime.Client.list_public_keys().

See also: AWS API Documentation

Request Syntax

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

Parameters:

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

{
    'publicKeys': [
        {
            'arn': 'string',
            'name': 'string',
            'tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • publicKeys (list) –

    List of the matching public keys (summary information only).

    • (dict) –

      Summary information about a public key.

      • arn (string) –

        Public key ARN.

      • name (string) –

        Public key name.

      • tags (dict) –

        Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and “Tag naming limits and requirements”; Amazon IVS has no constraints on tags beyond what is documented there.

        • (string) –

          • (string) –

  • NextToken (string) –

    A token to resume pagination.