AmazonIVSRealTime (AWS Java SDK for Amazon Interactive Video Service RealTime 1.12.490 API)

All Known Subinterfaces:

AmazonIVSRealTimeAsync

All Known Implementing Classes:

AbstractAmazonIVSRealTime, AbstractAmazonIVSRealTimeAsync, AmazonIVSRealTimeAsyncClient, AmazonIVSRealTimeClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonIVSRealTime
```
Interface for accessing ivsrealtime.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonIVSRealTime instead.

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.

Field Summary

Fields
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`CreateParticipantTokenResult`	`createParticipantToken(CreateParticipantTokenRequest createParticipantTokenRequest)` Creates an additional token for a specified stage.
`CreateStageResult`	`createStage(CreateStageRequest createStageRequest)` Creates a new stage (and optionally participant tokens).
`DeleteStageResult`	`deleteStage(DeleteStageRequest deleteStageRequest)` Shuts down and deletes the specified stage (disconnecting all participants).
`DisconnectParticipantResult`	`disconnectParticipant(DisconnectParticipantRequest disconnectParticipantRequest)` Disconnects a specified participant and revokes the participant permanently from a specified stage.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`GetParticipantResult`	`getParticipant(GetParticipantRequest getParticipantRequest)` Gets information about the specified participant token.
`GetStageResult`	`getStage(GetStageRequest getStageRequest)` Gets information for the specified stage.
`GetStageSessionResult`	`getStageSession(GetStageSessionRequest getStageSessionRequest)` Gets information for the specified stage session.
`ListParticipantEventsResult`	`listParticipantEvents(ListParticipantEventsRequest listParticipantEventsRequest)` Lists events for a specified participant that occurred during a specified stage session.
`ListParticipantsResult`	`listParticipants(ListParticipantsRequest listParticipantsRequest)` Lists all participants in a specified stage session.
`ListStagesResult`	`listStages(ListStagesRequest listStagesRequest)` Gets summary information about all stages in your account, in the AWS region where the API request is processed.
`ListStageSessionsResult`	`listStageSessions(ListStageSessionsRequest listStageSessionsRequest)` Gets all sessions for a specified stage.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)` Gets information about AWS tags for the specified ARN.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`TagResourceResult`	`tagResource(TagResourceRequest tagResourceRequest)` Adds or updates tags for the AWS resource with the specified ARN.
`UntagResourceResult`	`untagResource(UntagResourceRequest untagResourceRequest)` Removes tags from the resource with the specified ARN.
`UpdateStageResult`	`updateStage(UpdateStageRequest updateStageRequest)` Updates a stage’s configuration.

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.
    
    See Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - createParticipantToken
```
CreateParticipantTokenResult createParticipantToken(CreateParticipantTokenRequest createParticipantTokenRequest)
```
    Creates an additional token for a specified stage. This can be done after stage creation or when tokens expire. Tokens always are scoped to the stage for which they are created.
    
    Encryption keys are owned by Amazon IVS and never used directly by your application.
    
    Parameters:
    
    createParticipantTokenRequest -
    
    Returns:
    
    Result of the CreateParticipantToken operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    AccessDeniedException
    
    ServiceQuotaExceededException
    
    PendingVerificationException
    
    See Also:
    
    AWS API Documentation
  - createStage
```
CreateStageResult createStage(CreateStageRequest createStageRequest)
```
    Creates a new stage (and optionally participant tokens).
    
    Parameters:
    
    createStageRequest -
    
    Returns:
    
    Result of the CreateStage operation returned by the service.
    
    Throws:
    
    ValidationException
    
    AccessDeniedException
    
    ServiceQuotaExceededException
    
    PendingVerificationException
    
    See Also:
    
    AWS API Documentation
  - deleteStage
```
DeleteStageResult deleteStage(DeleteStageRequest deleteStageRequest)
```
    Shuts down and deletes the specified stage (disconnecting all participants).
    
    Parameters:
    
    deleteStageRequest -
    
    Returns:
    
    Result of the DeleteStage operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    AccessDeniedException
    
    ConflictException
    
    PendingVerificationException
    
    See Also:
    
    AWS API Documentation
  - disconnectParticipant
```
DisconnectParticipantResult disconnectParticipant(DisconnectParticipantRequest disconnectParticipantRequest)
```
    Disconnects a specified participant and revokes the participant permanently from a specified stage.
    
    Parameters:
    
    disconnectParticipantRequest -
    
    Returns:
    
    Result of the DisconnectParticipant operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    AccessDeniedException
    
    PendingVerificationException
    
    See Also:
    
    AWS API Documentation
  - getParticipant
```
GetParticipantResult getParticipant(GetParticipantRequest getParticipantRequest)
```
    Gets information about the specified participant token.
    
    Parameters:
    
    getParticipantRequest -
    
    Returns:
    
    Result of the GetParticipant operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    AccessDeniedException
    
    See Also:
    
    AWS API Documentation
  - getStage
```
GetStageResult getStage(GetStageRequest getStageRequest)
```
    Gets information for the specified stage.
    
    Parameters:
    
    getStageRequest -
    
    Returns:
    
    Result of the GetStage operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    AccessDeniedException
    
    See Also:
    
    AWS API Documentation
  - getStageSession
```
GetStageSessionResult getStageSession(GetStageSessionRequest getStageSessionRequest)
```
    Gets information for the specified stage session.
    
    Parameters:
    
    getStageSessionRequest -
    
    Returns:
    
    Result of the GetStageSession operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    AccessDeniedException
    
    See Also:
    
    AWS API Documentation
  - listParticipantEvents
```
ListParticipantEventsResult listParticipantEvents(ListParticipantEventsRequest listParticipantEventsRequest)
```
    Lists events for a specified participant that occurred during a specified stage session.
    
    Parameters:
    
    listParticipantEventsRequest -
    
    Returns:
    
    Result of the ListParticipantEvents operation returned by the service.
    
    Throws:
    
    ValidationException
    
    AccessDeniedException
    
    See Also:
    
    AWS API Documentation
  - listParticipants
```
ListParticipantsResult listParticipants(ListParticipantsRequest listParticipantsRequest)
```
    Lists all participants in a specified stage session.
    
    Parameters:
    
    listParticipantsRequest -
    
    Returns:
    
    Result of the ListParticipants operation returned by the service.
    
    Throws:
    
    ValidationException
    
    AccessDeniedException
    
    See Also:
    
    AWS API Documentation
  - listStageSessions
```
ListStageSessionsResult listStageSessions(ListStageSessionsRequest listStageSessionsRequest)
```
    Gets all sessions for a specified stage.
    
    Parameters:
    
    listStageSessionsRequest -
    
    Returns:
    
    Result of the ListStageSessions operation returned by the service.
    
    Throws:
    
    ValidationException
    
    AccessDeniedException
    
    See Also:
    
    AWS API Documentation
  - listStages
```
ListStagesResult listStages(ListStagesRequest listStagesRequest)
```
    Gets summary information about all stages in your account, in the AWS region where the API request is processed.
    
    Parameters:
    
    listStagesRequest -
    
    Returns:
    
    Result of the ListStages operation returned by the service.
    
    Throws:
    
    ValidationException
    
    AccessDeniedException
    
    ConflictException
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
```
    Gets information about AWS tags for the specified ARN.
    
    Parameters:
    
    listTagsForResourceRequest -
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    InternalServerException
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
```
    Adds or updates tags for the AWS resource with the specified ARN.
    
    Parameters:
    
    tagResourceRequest -
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    InternalServerException
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
```
    Removes tags from the resource with the specified ARN.
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    InternalServerException
    
    See Also:
    
    AWS API Documentation
  - updateStage
```
UpdateStageResult updateStage(UpdateStageRequest updateStageRequest)
```
    Updates a stage’s configuration.
    
    Parameters:
    
    updateStageRequest -
    
    Returns:
    
    Result of the UpdateStage operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    AccessDeniedException
    
    ServiceQuotaExceededException
    
    PendingVerificationException
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
void shutdown()
```
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
  - getCachedResponseMetadata
```
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Interface AmazonIVSRealTime

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

createParticipantToken

createStage

deleteStage

disconnectParticipant

getParticipant

getStage

getStageSession

listParticipantEvents

listParticipants

listStageSessions

listStages

listTagsForResource

tagResource

untagResource

updateStage

shutdown

getCachedResponseMetadata