IVS / Client / batch_get_stream_key

batch_get_stream_key#

IVS.Client.batch_get_stream_key(**kwargs)#

Performs GetStreamKey on multiple ARNs simultaneously.

Request Syntax

response = client.batch_get_stream_key(
    arns=[
        'string',
    ]
)

Parameters:

arns (list) –

[REQUIRED]

Array of ARNs, one per stream key.

(string) –

Return type:

dict

Returns:

Response Syntax

{
    'streamKeys': [
        {
            'arn': 'string',
            'value': 'string',
            'channelArn': 'string',
            'tags': {
                'string': 'string'
            }
        },
    ],
    'errors': [
        {
            'arn': 'string',
            'code': 'string',
            'message': 'string'
        },
    ]
}

Response Structure

(dict) –
- streamKeys (list) –
  - (dict) –
    
    Object specifying a stream key.
    - arn (string) –
      
      Stream-key ARN.
    - value (string) –
      
      Stream-key value.
    - 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) –
- errors (list) –
  - (dict) –
    
    Error related to a specific channel, specified by its ARN.
    - arn (string) –
      
      ARN of an IVS resource; e.g., channel.
    - code (string) –
      
      Error code.
    - message (string) –
      
      Error message, determined by the application.