ivsrealtime_list_participants

Lists all participants in a specified stage session.
See <a href="https://www.paws-r-sdk.com/docs/ivsrealtime_list_participants/">https://www.paws-r-sdk.com/docs/ivsrealtime_list_participants/</a> for full documentation.

internal

Interface to 'Amazon Web Services' 'analytics' services,
including 'Elastic MapReduce' 'Hadoop' and 'Spark' big data service,
'Elasticsearch' search engine, and more <https://aws.amazon.com/>.

Dyfan Jones

paws.analytics

'Amazon Web Services' Analytics Services

David Kretch

Adam Banker

Amazon.com, Inc. 

ivsrealtime_list_participants function

<dl><dt>filterByPublished</dt>
<dd>Filters the response list to only show participants who published during
the stage session. Only one of <code>filterByUserId</code>, <code>filterByPublished</code>, or
<code>filterByState</code> can be provided per request.</dd>
<dt>filterByState</dt>
<dd>Filters the response list to only show participants in the specified
state. Only one of <code>filterByUserId</code>, <code>filterByPublished</code>, or
<code>filterByState</code> can be provided per request.</dd>
<dt>filterByUserId</dt>
<dd>Filters the response list to match the specified user ID. Only one of
<code>filterByUserId</code>, <code>filterByPublished</code>, or <code>filterByState</code> can be
provided per request. A <code>userId</code> is a customer-assigned name to help
identify the token; this can be used to link a participant to a user in
the customer’s own systems.</dd>
<dt>maxResults</dt>
<dd>Maximum number of results to return. Default: 50.</dd>
<dt>nextToken</dt>
<dd>The first participant to retrieve. This is used for pagination; see the
<code>nextToken</code> response field.</dd>
<dt>sessionId</dt>
<dd>[required] ID of the session within the stage.</dd>
<dt>stageArn</dt>
<dd>[required] Stage ARN.</dd></dl>

Arguments

Lists all participants in a specified stage session.
See <a href='https://www.paws-r-sdk.com/docs/ivsrealtime_list_participants/'>https://www.paws-r-sdk.com/docs/ivsrealtime_list_participants/</a> for full documentation.

Lists all participants in a specified stage session — ivsrealtime_list_participants

<dl>

<dt>filterByPublished</dt>
<dd>Filters the response list to only show participants who published during
the stage session. Only one of <code>filterByUserId</code>, <code>filterByPublished</code>, or
<code>filterByState</code> can be provided per request.</dd>


<dt>filterByState</dt>
<dd>Filters the response list to only show participants in the specified
state. Only one of <code>filterByUserId</code>, <code>filterByPublished</code>, or
<code>filterByState</code> can be provided per request.</dd>


<dt>filterByUserId</dt>
<dd>Filters the response list to match the specified user ID. Only one of
<code>filterByUserId</code>, <code>filterByPublished</code>, or <code>filterByState</code> can be
provided per request. A <code>userId</code> is a customer-assigned name to help
identify the token; this can be used to link a participant to a user in
the customer’s own systems.</dd>


<dt>maxResults</dt>
<dd>Maximum number of results to return. Default: 50.</dd>


<dt>nextToken</dt>
<dd>The first participant to retrieve. This is used for pagination; see the
<code>nextToken</code> response field.</dd>


<dt>sessionId</dt>
<dd>[required] ID of the session within the stage.</dd>


<dt>stageArn</dt>
<dd>[required] Stage ARN.</dd>

</dl>

ivsrealtime_list_participants: Lists all participants in a specified stage session

Description

Usage

Arguments