ivsrealtime / Client / list_stages
list_stages#
- ivsrealtime.Client.list_stages(**kwargs)#
Gets summary information about all stages in your account, in the AWS region where the API request is processed.
See also: AWS API Documentation
Request Syntax
response = client.list_stages( nextToken='string', maxResults=123 )
- Parameters:
nextToken (string) – The first stage to retrieve. This is used for pagination; see the
nextToken
response field.maxResults (integer) – Maximum number of results to return. Default: 50.
- Return type:
dict
- Returns:
Response Syntax
{ 'stages': [ { 'arn': 'string', 'name': 'string', 'activeSessionId': 'string', 'tags': { 'string': 'string' } }, ], 'nextToken': 'string' }
Response Structure
(dict) –
stages (list) –
List of the matching stages (summary information only).
(dict) –
Summary information about a stage.
arn (string) –
Stage ARN.
name (string) –
Stage name.
activeSessionId (string) –
ID of the active session within the stage.
tags (dict) –
Tags attached to the resource. Array of maps, each of the form
string:string (key:value)
. See Best practices and strategies in Tagging AWS Resources and Tag Editor 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) –
nextToken (string) –
If there are more stages than
maxResults
, usenextToken
in the request to get the next set.
Exceptions
ivsrealtime.Client.exceptions.ValidationException
ivsrealtime.Client.exceptions.AccessDeniedException
ivsrealtime.Client.exceptions.ConflictException