aws ivs-realtime list-participants

Lists all participants in a specified stage session. AWS CLI reference

3 examples 8 options Its page in the AWS CLI reference

Examples

from aws-cli, each command read by CmdID

Example 1: To get a list of stage participants

The following list-participants example lists all participants for a specified session ID of a specified stage ARN (Amazon Resource Name).

aws ivs-realtime list-participants --stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh --session-id st-a1b2c3d4e5f6g

Identify

--stage-arnStage ARN.

--session-idID of the session within the stage.

Its output

{
    "participants": [
        {
            "firstJoinTime": "2023-04-26T20:30:34+00:00",
            "participantId": "abCDEf12GHIj",
            "published": true,
            "recordingState": "STOPPED",
            "state": "DISCONNECTED",
            "userId": ""
        }
    ]
}

For more information, see Enabling Multiple Hosts on an Amazon IVS Stream in the Amazon IVS Low-Latency Streaming User Guide.

Example 2: To get a list of stage participants, when a participant has been replicated to another stage

The following list-participants example lists all participants for a specified session ID of a specified stage ARN (Amazon Resource Name), when a participant has been replicated to another stage.

aws ivs-realtime list-participants --stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh --session-id st-a1b2c3d4e5f6g

Identify

--stage-arnStage ARN.

--session-idID of the session within the stage.

Its output

{
    "participants": [
        {
            "firstJoinTime": "2023-04-26T20:30:34+00:00",
            "participantId": "abCDEf12GHIj",
            "published": true,
            "recordingState": "STOPPED",
            "state": "DISCONNECTED",
            "userId": "",
            "replicationState": "ACTIVE",
            "replicationType": "SOURCE",
            "sourceStageArn": "",
            "sourceSessionId": ""
        }
    ]
}

For more information, see Enabling Multiple Hosts on an Amazon IVS Stream in the Amazon IVS Low-Latency Streaming User Guide.

Example 3: To get a list of stage participants, when a participant has been replicated from another stage

The following list-participants example lists all participants for a specified session ID of a specified stage ARN (Amazon Resource Name), when a participant has been replicated from another stage.

aws ivs-realtime list-participants --stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh --session-id st-a1b2c3d4e5f6g

Identify

--stage-arnStage ARN.

--session-idID of the session within the stage.

Its output

{
    "participants": [
        {
            "firstJoinTime": "2023-04-26T20:30:34+00:00",
            "participantId": "abCDEf12GHIj",
            "published": true,
            "recordingState": "STOPPED",
            "state": "DISCONNECTED",
            "userId": "",
            "replicationState": "ACTIVE",
            "replicationType": "REPLICA",
            "sourceStageArn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh",
            "sourceSessionId": "st-a1b2c3d4e5f6g"
        }
    ]
}

For more information, see Enabling Multiple Hosts on an Amazon IVS Stream in the Amazon IVS Low-Latency Streaming User Guide.

Options

8 in the AWS CLI reference

--filter-by-publishedFilters the response list to only show participants who published during the stage session.

--filter-by-recording-stateFilters the response list to only show participants with the specified recording state.

--filter-by-stateFilters the response list to only show participants in the specified state.

--filter-by-user-idFilters the response list to match the specified user ID.

--max-resultsMaximum number of results to return.

--next-tokenThe first participant to retrieve.

--session-idID of the session within the stage.

--stage-arnStage ARN.