get_stream_key

IVS.Client.get_stream_key(**kwargs)

Gets stream-key information for a specified ARN.

See also: AWS API Documentation

Request Syntax

response = client.get_stream_key(
    arn='string'
)

Parameters

arn (string) --

[REQUIRED]

ARN for the stream key to be retrieved.

Return type

dict

Returns

Response Syntax

{
    'streamKey': {
        'arn': 'string',
        'channelArn': 'string',
        'tags': {
            'string': 'string'
        },
        'value': 'string'
    }
}

Response Structure

• (dict) --
  • streamKey (dict) --
    • 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) --
    • value (string) --

      Stream-key value.

Exceptions

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