/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ /** *

* Introduction *

* The Amazon Interactive Video Service (IVS) stage API is REST compatible, using a standard HTTP API and an AWS * EventBridge event stream for responses. JSON is used for both requests and responses, including errors. *

* Terminology: *

*
* The IVS stage API sometimes is referred to as the IVS RealTime API. *
*
*
* A participant token is an authorization token used to publish/subscribe to a stage. *
*
*
* A participant object represents participants (people) in the stage and contains information about them. When a * token is created, it includes a participant ID; when a participant uses that token to join a stage, the participant * is associated with that participant ID There is a 1:1 mapping between participant tokens and participants. *
*

* Resources *

* The following resources contain information about your IVS live stream (see Getting Started with Amazon IVS): *

*
* Stage — A stage is a virtual space where multiple participants can exchange audio and video in real time. *
*

* Tagging *

* A tag is a metadata label that you assign to an AWS resource. A tag comprises a key and a value, * both set by you. For example, you might set a tag as topic:nature to label a particular video category. * See Tagging AWS Resources for more * information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS stages * has no service-specific constraints beyond what is documented there. *

* Tags can help you identify and organize your AWS resources. For example, you can use the same tag for different * resources to indicate that they are related. You can also use tags to manage access (see Access Tags). *

* The Amazon IVS stage API has these tag-related endpoints: TagResource, UntagResource, and * ListTagsForResource. The following resource supports tagging: Stage. *

* At most 50 tags can be applied to a resource. *

* Stages Endpoints *

*
* CreateParticipantToken — Creates an additional token for a specified stage. This can be done after stage * creation or when tokens expire. *
*
*
* CreateStage — Creates a new stage (and optionally participant tokens). *
*
*
* DeleteStage — Shuts down and deletes the specified stage (disconnecting all participants). *
*
*
* DisconnectParticipant — Disconnects a specified participant and revokes the participant permanently from a * specified stage. *
*
*
* GetParticipant — Gets information about the specified participant token. *
*
*
* GetStage — Gets information for the specified stage. *
*
*
* GetStageSession — Gets information for the specified stage session. *
*
*
* ListParticipantEvents — Lists events for a specified participant that occurred during a specified stage * session. *
*
*
* ListParticipants — Lists all participants in a specified stage session. *
*
*
* ListStages — Gets summary information about all stages in your account, in the AWS region where the API * request is processed. *
*
*
* ListStageSessions — Gets all sessions for a specified stage. *
*
*
* UpdateStage — Updates a stage’s configuration. *
*

* Tags Endpoints *

*
* ListTagsForResource — Gets information about AWS tags for the specified ARN. *
*
*
* TagResource — Adds or updates tags for the AWS resource with the specified ARN. *
*
*
* UntagResource — Removes tags from the resource with the specified ARN. *
*

*/ package com.amazonaws.services.ivsrealtime;