list_stream_keys

IVS.Client.list_stream_keys(**kwargs)

Gets summary information about stream keys for the specified channel.

See also: AWS API Documentation

Request Syntax

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

Parameters

• channelArn (string) --

  [REQUIRED]

  Channel ARN used to filter the list.

• maxResults (integer) -- Maximum number of streamKeys to return. Default: 1.
• nextToken (string) -- The first stream key to retrieve. This is used for pagination; see the nextToken response field.

Return type

dict

Returns

Response Syntax

{
    'nextToken': 'string',
    'streamKeys': [
        {
            'arn': 'string',
            'channelArn': 'string',
            'tags': {
                'string': 'string'
            }
        },
    ]
}

Response Structure

• (dict) --

  • nextToken (string) --

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

  • streamKeys (list) --

    List of stream keys.

    • (dict) --

      Summary information about a stream key.

      • arn (string) --

        Stream-key ARN.

      • channelArn (string) --

        Channel ARN for the stream.

      • 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) --

Exceptions

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