ivsrealtime / Client / get_stage
get_stage#
- ivsrealtime.Client.get_stage(**kwargs)#
Gets information for the specified stage.
See also: AWS API Documentation
Request Syntax
response = client.get_stage( arn='string' )
- Parameters:
arn (string) –
[REQUIRED]
ARN of the stage for which the information is to be retrieved.
- Return type:
dict
- Returns:
Response Syntax
{ 'stage': { 'activeSessionId': 'string', 'arn': 'string', 'name': 'string', 'tags': { 'string': 'string' } } }
Response Structure
(dict) –
stage (dict) –
The stage that is returned.
activeSessionId (string) –
ID of the active session within the stage.
arn (string) –
Stage ARN.
name (string) –
Stage name.
tags (dict) –
Tags attached to the resource. Array of maps, each of the form
string:string (key:value)
. See Tagging AWS Resources for details, including restrictions that apply to tags and “Tag naming limits and requirements”; Amazon IVS has no constraints on tags beyond what is documented there.(string) –
(string) –
Exceptions
ivsrealtime.Client.exceptions.ResourceNotFoundException
ivsrealtime.Client.exceptions.ValidationException
ivsrealtime.Client.exceptions.AccessDeniedException