aws ivs-realtime create-participant-token

Creates an additional token for a specified stage. AWS CLI reference

1 example 5 options Its page in the AWS CLI reference

Examples

from aws-cli, each command read by CmdID

To create a stage participant token

The following create-participant-token example creates a participant toke for the specified stage.

aws ivs-realtime create-participant-token --stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh --user-id bob

Identify

--stage-arnARN of the stage to which this token is scoped.

--user-idName that can be specified to help identify the token.

Its output

{
    "participantToken": {
        "expirationTime": "2023-03-07T09:47:43+00:00",
        "participantId": "ABCDEfghij01234KLMN6789",
        "token": "abcd1234defg5678"
    }
}

For more information, see Enabling Multiple Hosts on an Amazon IVS Stream in the Amazon Interactive Video Service User Guide.

Options

5 in the AWS CLI reference

--attributesApplication-provided attributes to encode into the token and attach to a stage.

--capabilitiesSet of capabilities that the user is allowed to perform in the stage.

--durationDuration (in minutes), after which the token expires.

--stage-arnARN of the stage to which this token is scoped.

--user-idName that can be specified to help identify the token.