list_playback_key_pairs

IVS.Client.list_playback_key_pairs(**kwargs)

Gets summary information about playback key pairs. For more information, see Setting Up Private Channels in the Amazon IVS User Guide .

See also: AWS API Documentation

Request Syntax

response = client.list_playback_key_pairs(
    maxResults=123,
    nextToken='string'
)

Parameters

• maxResults (integer) -- Maximum number of key pairs to return. Default: your service quota or 100, whichever is smaller.
• nextToken (string) -- The first key pair to retrieve. This is used for pagination; see the nextToken response field.

Return type

dict

Returns

Response Syntax

{
    'keyPairs': [
        {
            'arn': 'string',
            'name': 'string',
            'tags': {
                'string': 'string'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) --

  • keyPairs (list) --

    List of key pairs.

    • (dict) --

      Summary information about a playback key pair.

      • arn (string) --

        Key-pair ARN.

      • name (string) --

        Playback-key-pair name. The value does not need to be unique.

      • tags (dict) --

        Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value) . See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

        • (string) --
          • (string) --

  • nextToken (string) --

    If there are more key pairs than maxResults , use nextToken in the request to get the next set.

Exceptions

• IVS.Client.exceptions.AccessDeniedException
• IVS.Client.exceptions.ValidationException