IVS / Client / create_stream_key

create_stream_key#

IVS.Client.create_stream_key(**kwargs)#

Creates a stream key, used to initiate a stream, for the specified channel ARN.

Note that CreateChannel creates a stream key. If you subsequently use CreateStreamKey on the same channel, it will fail because a stream key already exists and there is a limit of 1 stream key per channel. To reset the stream key on a channel, use DeleteStreamKey and then CreateStreamKey.

See also: AWS API Documentation

Request Syntax

response = client.create_stream_key(
    channelArn='string',
    tags={
        'string': 'string'
    }
)
Parameters:
  • channelArn (string) –

    [REQUIRED]

    ARN of the channel for which to create the stream key.

  • tags (dict) –

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

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • streamKey (dict) –

      Stream key used to authenticate an RTMPS stream for ingestion.

      • 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

  • IVS.Client.exceptions.PendingVerification

  • IVS.Client.exceptions.ServiceQuotaExceededException