AmazonIVSRealTimeClient (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceClient
- - com.amazonaws.services.ivsrealtime.AmazonIVSRealTimeClient

All Implemented Interfaces:

AmazonIVSRealTime

Direct Known Subclasses:

AmazonIVSRealTimeAsyncClient
```
@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonIVSRealTimeClient
extends AmazonWebServiceClient
implements AmazonIVSRealTime
```
Client for accessing ivsrealtime. All service calls made using this client are blocking, and will not return until the service call completes.

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 inherited from class com.amazonaws.AmazonWebServiceClient
  LOGGING_AWS_REQUEST_METRIC
- Fields inherited from interface com.amazonaws.services.ivsrealtime.AmazonIVSRealTime
  ENDPOINT_PREFIX

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static AmazonIVSRealTimeClientBuilder`	`builder()`
`CreateParticipantTokenResult`	`createParticipantToken(CreateParticipantTokenRequest request)` Creates an additional token for a specified stage.
`CreateStageResult`	`createStage(CreateStageRequest request)` Creates a new stage (and optionally participant tokens).
`DeleteStageResult`	`deleteStage(DeleteStageRequest request)` Shuts down and deletes the specified stage (disconnecting all participants).
`DisconnectParticipantResult`	`disconnectParticipant(DisconnectParticipantRequest request)` 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 request)` Gets information about the specified participant token.
`GetStageResult`	`getStage(GetStageRequest request)` Gets information for the specified stage.
`GetStageSessionResult`	`getStageSession(GetStageSessionRequest request)` Gets information for the specified stage session.
`ListParticipantEventsResult`	`listParticipantEvents(ListParticipantEventsRequest request)` Lists events for a specified participant that occurred during a specified stage session.
`ListParticipantsResult`	`listParticipants(ListParticipantsRequest request)` Lists all participants in a specified stage session.
`ListStagesResult`	`listStages(ListStagesRequest request)` Gets summary information about all stages in your account, in the AWS region where the API request is processed.
`ListStageSessionsResult`	`listStageSessions(ListStageSessionsRequest request)` Gets all sessions for a specified stage.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` 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 request)` Adds or updates tags for the AWS resource with the specified ARN.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Removes tags from the resource with the specified ARN.
`UpdateStageResult`	`updateStage(UpdateStageRequest request)` Updates a stage’s configuration.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - builder
```
public static AmazonIVSRealTimeClientBuilder builder()
```
  - createParticipantToken
```
public CreateParticipantTokenResult createParticipantToken(CreateParticipantTokenRequest request)
```
    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.
    
    Specified by:
    
    createParticipantToken in interface AmazonIVSRealTime
    
    Parameters:
    
    createParticipantTokenRequest -
    
    Returns:
    
    Result of the CreateParticipantToken operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    AccessDeniedException
    
    ServiceQuotaExceededException
    
    PendingVerificationException
    
    See Also:
    
    AWS API Documentation
  - createStage
```
public CreateStageResult createStage(CreateStageRequest request)
```
    Creates a new stage (and optionally participant tokens).
    
    Specified by:
    
    createStage in interface AmazonIVSRealTime
    
    Parameters:
    
    createStageRequest -
    
    Returns:
    
    Result of the CreateStage operation returned by the service.
    
    Throws:
    
    ValidationException
    
    AccessDeniedException
    
    ServiceQuotaExceededException
    
    PendingVerificationException
    
    See Also:
    
    AWS API Documentation
  - deleteStage
```
public DeleteStageResult deleteStage(DeleteStageRequest request)
```
    Shuts down and deletes the specified stage (disconnecting all participants).
    
    Specified by:
    
    deleteStage in interface AmazonIVSRealTime
    
    Parameters:
    
    deleteStageRequest -
    
    Returns:
    
    Result of the DeleteStage operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    AccessDeniedException
    
    ConflictException
    
    PendingVerificationException
    
    See Also:
    
    AWS API Documentation
  - disconnectParticipant
```
public DisconnectParticipantResult disconnectParticipant(DisconnectParticipantRequest request)
```
    Disconnects a specified participant and revokes the participant permanently from a specified stage.
    
    Specified by:
    
    disconnectParticipant in interface AmazonIVSRealTime
    
    Parameters:
    
    disconnectParticipantRequest -
    
    Returns:
    
    Result of the DisconnectParticipant operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    AccessDeniedException
    
    PendingVerificationException
    
    See Also:
    
    AWS API Documentation
  - getParticipant
```
public GetParticipantResult getParticipant(GetParticipantRequest request)
```
    Gets information about the specified participant token.
    
    Specified by:
    
    getParticipant in interface AmazonIVSRealTime
    
    Parameters:
    
    getParticipantRequest -
    
    Returns:
    
    Result of the GetParticipant operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    AccessDeniedException
    
    See Also:
    
    AWS API Documentation
  - getStage
```
public GetStageResult getStage(GetStageRequest request)
```
    Gets information for the specified stage.
    
    Specified by:
    
    getStage in interface AmazonIVSRealTime
    
    Parameters:
    
    getStageRequest -
    
    Returns:
    
    Result of the GetStage operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    AccessDeniedException
    
    See Also:
    
    AWS API Documentation
  - getStageSession
```
public GetStageSessionResult getStageSession(GetStageSessionRequest request)
```
    Gets information for the specified stage session.
    
    Specified by:
    
    getStageSession in interface AmazonIVSRealTime
    
    Parameters:
    
    getStageSessionRequest -
    
    Returns:
    
    Result of the GetStageSession operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    AccessDeniedException
    
    See Also:
    
    AWS API Documentation
  - listParticipantEvents
```
public ListParticipantEventsResult listParticipantEvents(ListParticipantEventsRequest request)
```
    Lists events for a specified participant that occurred during a specified stage session.
    
    Specified by:
    
    listParticipantEvents in interface AmazonIVSRealTime
    
    Parameters:
    
    listParticipantEventsRequest -
    
    Returns:
    
    Result of the ListParticipantEvents operation returned by the service.
    
    Throws:
    
    ValidationException
    
    AccessDeniedException
    
    See Also:
    
    AWS API Documentation
  - listParticipants
```
public ListParticipantsResult listParticipants(ListParticipantsRequest request)
```
    Lists all participants in a specified stage session.
    
    Specified by:
    
    listParticipants in interface AmazonIVSRealTime
    
    Parameters:
    
    listParticipantsRequest -
    
    Returns:
    
    Result of the ListParticipants operation returned by the service.
    
    Throws:
    
    ValidationException
    
    AccessDeniedException
    
    See Also:
    
    AWS API Documentation
  - listStageSessions
```
public ListStageSessionsResult listStageSessions(ListStageSessionsRequest request)
```
    Gets all sessions for a specified stage.
    
    Specified by:
    
    listStageSessions in interface AmazonIVSRealTime
    
    Parameters:
    
    listStageSessionsRequest -
    
    Returns:
    
    Result of the ListStageSessions operation returned by the service.
    
    Throws:
    
    ValidationException
    
    AccessDeniedException
    
    See Also:
    
    AWS API Documentation
  - listStages
```
public ListStagesResult listStages(ListStagesRequest request)
```
    Gets summary information about all stages in your account, in the AWS region where the API request is processed.
    
    Specified by:
    
    listStages in interface AmazonIVSRealTime
    
    Parameters:
    
    listStagesRequest -
    
    Returns:
    
    Result of the ListStages operation returned by the service.
    
    Throws:
    
    ValidationException
    
    AccessDeniedException
    
    ConflictException
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Gets information about AWS tags for the specified ARN.
    
    Specified by:
    
    listTagsForResource in interface AmazonIVSRealTime
    
    Parameters:
    
    listTagsForResourceRequest -
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    InternalServerException
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Adds or updates tags for the AWS resource with the specified ARN.
    
    Specified by:
    
    tagResource in interface AmazonIVSRealTime
    
    Parameters:
    
    tagResourceRequest -
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    InternalServerException
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Removes tags from the resource with the specified ARN.
    
    Specified by:
    
    untagResource in interface AmazonIVSRealTime
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    InternalServerException
    
    See Also:
    
    AWS API Documentation
  - updateStage
```
public UpdateStageResult updateStage(UpdateStageRequest request)
```
    Updates a stage’s configuration.
    
    Specified by:
    
    updateStage in interface AmazonIVSRealTime
    
    Parameters:
    
    updateStageRequest -
    
    Returns:
    
    Result of the UpdateStage operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    AccessDeniedException
    
    ServiceQuotaExceededException
    
    PendingVerificationException
    
    See Also:
    
    AWS API Documentation
  - getCachedResponseMetadata
```
public 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 the request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AmazonIVSRealTime
    
    Parameters:
    
    request - The originally executed request
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.
  - shutdown
```
public void shutdown()
```
    Description copied from class: AmazonWebServiceClient
    
    Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AmazonIVSRealTime
    
    Overrides:
    
    shutdown in class AmazonWebServiceClient

Did this page help you?

Class AmazonIVSRealTimeClient

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

Fields inherited from interface com.amazonaws.services.ivsrealtime.AmazonIVSRealTime

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

Method Detail

builder

createParticipantToken

createStage

deleteStage

disconnectParticipant

getParticipant

getStage

getStageSession

listParticipantEvents

listParticipants

listStageSessions

listStages

listTagsForResource

tagResource

untagResource

updateStage

getCachedResponseMetadata

shutdown