@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonIVSRealTime
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonIVSRealTime instead.
The Amazon Interactive Video Service (IVS) real-time 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.
Key Concepts
Stage — A virtual space where participants can exchange video in real time.
Participant token — A token that authenticates a participant when they join a stage.
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.
For server-side composition:
Composition process — Composites participants of a stage into a single video and forwards it to a set of outputs (e.g., IVS channels). Composition endpoints support this process.
Composition — Controls the look of the outputs, including how participants are positioned in the video.
For more information about your IVS live stream, also see Getting Started with Amazon IVS Real-Time Streaming.
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 real-time 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.
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| Modifier and Type | Method and Description |
|---|---|
CreateEncoderConfigurationResult |
createEncoderConfiguration(CreateEncoderConfigurationRequest createEncoderConfigurationRequest)
Creates an EncoderConfiguration object.
|
CreateParticipantTokenResult |
createParticipantToken(CreateParticipantTokenRequest createParticipantTokenRequest)
Creates an additional token for a specified stage.
|
CreateStageResult |
createStage(CreateStageRequest createStageRequest)
Creates a new stage (and optionally participant tokens).
|
CreateStorageConfigurationResult |
createStorageConfiguration(CreateStorageConfigurationRequest createStorageConfigurationRequest)
Creates a new storage configuration, used to enable recording to Amazon S3.
|
DeleteEncoderConfigurationResult |
deleteEncoderConfiguration(DeleteEncoderConfigurationRequest deleteEncoderConfigurationRequest)
Deletes an EncoderConfiguration resource.
|
DeletePublicKeyResult |
deletePublicKey(DeletePublicKeyRequest deletePublicKeyRequest)
Deletes the specified public key used to sign stage participant tokens.
|
DeleteStageResult |
deleteStage(DeleteStageRequest deleteStageRequest)
Shuts down and deletes the specified stage (disconnecting all participants).
|
DeleteStorageConfigurationResult |
deleteStorageConfiguration(DeleteStorageConfigurationRequest deleteStorageConfigurationRequest)
Deletes the storage configuration for the specified ARN.
|
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.
|
GetCompositionResult |
getComposition(GetCompositionRequest getCompositionRequest)
Get information about the specified Composition resource.
|
GetEncoderConfigurationResult |
getEncoderConfiguration(GetEncoderConfigurationRequest getEncoderConfigurationRequest)
Gets information about the specified EncoderConfiguration resource.
|
GetParticipantResult |
getParticipant(GetParticipantRequest getParticipantRequest)
Gets information about the specified participant token.
|
GetPublicKeyResult |
getPublicKey(GetPublicKeyRequest getPublicKeyRequest)
Gets information for the specified public key.
|
GetStageResult |
getStage(GetStageRequest getStageRequest)
Gets information for the specified stage.
|
GetStageSessionResult |
getStageSession(GetStageSessionRequest getStageSessionRequest)
Gets information for the specified stage session.
|
GetStorageConfigurationResult |
getStorageConfiguration(GetStorageConfigurationRequest getStorageConfigurationRequest)
Gets the storage configuration for the specified ARN.
|
ImportPublicKeyResult |
importPublicKey(ImportPublicKeyRequest importPublicKeyRequest)
Import a public key to be used for signing stage participant tokens.
|
ListCompositionsResult |
listCompositions(ListCompositionsRequest listCompositionsRequest)
Gets summary information about all Compositions in your account, in the AWS region where the API request is
processed.
|
ListEncoderConfigurationsResult |
listEncoderConfigurations(ListEncoderConfigurationsRequest listEncoderConfigurationsRequest)
Gets summary information about all EncoderConfigurations in your account, in the AWS region where the API request
is processed.
|
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.
|
ListPublicKeysResult |
listPublicKeys(ListPublicKeysRequest listPublicKeysRequest)
Gets summary information about all public keys in your account, in the AWS region where the API request is
processed.
|
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.
|
ListStorageConfigurationsResult |
listStorageConfigurations(ListStorageConfigurationsRequest listStorageConfigurationsRequest)
Gets summary information about all storage configurations in your account, in the AWS region where the API
request is processed.
|
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.
|
StartCompositionResult |
startComposition(StartCompositionRequest startCompositionRequest)
Starts a Composition from a stage based on the configuration provided in the request.
|
StopCompositionResult |
stopComposition(StopCompositionRequest stopCompositionRequest)
Stops and deletes a Composition resource.
|
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.
|
static final String ENDPOINT_PREFIX
CreateEncoderConfigurationResult createEncoderConfiguration(CreateEncoderConfigurationRequest createEncoderConfigurationRequest)
Creates an EncoderConfiguration object.
createEncoderConfigurationRequest - ResourceNotFoundExceptionValidationExceptionAccessDeniedExceptionInternalServerExceptionServiceQuotaExceededExceptionConflictExceptionPendingVerificationExceptionCreateParticipantTokenResult 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.
createParticipantTokenRequest - ResourceNotFoundExceptionValidationExceptionAccessDeniedExceptionServiceQuotaExceededExceptionPendingVerificationExceptionCreateStageResult createStage(CreateStageRequest createStageRequest)
Creates a new stage (and optionally participant tokens).
createStageRequest - ValidationExceptionAccessDeniedExceptionServiceQuotaExceededExceptionPendingVerificationExceptionCreateStorageConfigurationResult createStorageConfiguration(CreateStorageConfigurationRequest createStorageConfigurationRequest)
Creates a new storage configuration, used to enable recording to Amazon S3. When a StorageConfiguration is created, IVS will modify the S3 bucketPolicy of the provided bucket. This will ensure that IVS has sufficient permissions to write content to the provided bucket.
createStorageConfigurationRequest - ResourceNotFoundExceptionValidationExceptionAccessDeniedExceptionInternalServerExceptionServiceQuotaExceededExceptionConflictExceptionPendingVerificationExceptionDeleteEncoderConfigurationResult deleteEncoderConfiguration(DeleteEncoderConfigurationRequest deleteEncoderConfigurationRequest)
Deletes an EncoderConfiguration resource. Ensures that no Compositions are using this template; otherwise, returns an error.
deleteEncoderConfigurationRequest - ResourceNotFoundExceptionValidationExceptionAccessDeniedExceptionInternalServerExceptionServiceQuotaExceededExceptionConflictExceptionDeletePublicKeyResult deletePublicKey(DeletePublicKeyRequest deletePublicKeyRequest)
Deletes the specified public key used to sign stage participant tokens. This invalidates future participant tokens generated using the key pair’s private key.
deletePublicKeyRequest - ResourceNotFoundExceptionValidationExceptionAccessDeniedExceptionConflictExceptionPendingVerificationExceptionDeleteStageResult deleteStage(DeleteStageRequest deleteStageRequest)
Shuts down and deletes the specified stage (disconnecting all participants).
deleteStageRequest - ResourceNotFoundExceptionValidationExceptionAccessDeniedExceptionConflictExceptionPendingVerificationExceptionDeleteStorageConfigurationResult deleteStorageConfiguration(DeleteStorageConfigurationRequest deleteStorageConfigurationRequest)
Deletes the storage configuration for the specified ARN.
If you try to delete a storage configuration that is used by a Composition, you will get an error (409 ConflictException). To avoid this, for all Compositions that reference the storage configuration, first use StopComposition and wait for it to complete, then use DeleteStorageConfiguration.
deleteStorageConfigurationRequest - ResourceNotFoundExceptionValidationExceptionAccessDeniedExceptionInternalServerExceptionServiceQuotaExceededExceptionConflictExceptionDisconnectParticipantResult disconnectParticipant(DisconnectParticipantRequest disconnectParticipantRequest)
Disconnects a specified participant and revokes the participant permanently from a specified stage.
disconnectParticipantRequest - ResourceNotFoundExceptionValidationExceptionAccessDeniedExceptionPendingVerificationExceptionGetCompositionResult getComposition(GetCompositionRequest getCompositionRequest)
Get information about the specified Composition resource.
getCompositionRequest - ResourceNotFoundExceptionValidationExceptionAccessDeniedExceptionInternalServerExceptionServiceQuotaExceededExceptionConflictExceptionGetEncoderConfigurationResult getEncoderConfiguration(GetEncoderConfigurationRequest getEncoderConfigurationRequest)
Gets information about the specified EncoderConfiguration resource.
getEncoderConfigurationRequest - ResourceNotFoundExceptionValidationExceptionAccessDeniedExceptionInternalServerExceptionServiceQuotaExceededExceptionConflictExceptionGetParticipantResult getParticipant(GetParticipantRequest getParticipantRequest)
Gets information about the specified participant token.
getParticipantRequest - ResourceNotFoundExceptionValidationExceptionAccessDeniedExceptionGetPublicKeyResult getPublicKey(GetPublicKeyRequest getPublicKeyRequest)
Gets information for the specified public key.
getPublicKeyRequest - ResourceNotFoundExceptionValidationExceptionAccessDeniedExceptionGetStageResult getStage(GetStageRequest getStageRequest)
Gets information for the specified stage.
getStageRequest - ResourceNotFoundExceptionValidationExceptionAccessDeniedExceptionGetStageSessionResult getStageSession(GetStageSessionRequest getStageSessionRequest)
Gets information for the specified stage session.
getStageSessionRequest - ResourceNotFoundExceptionValidationExceptionAccessDeniedExceptionGetStorageConfigurationResult getStorageConfiguration(GetStorageConfigurationRequest getStorageConfigurationRequest)
Gets the storage configuration for the specified ARN.
getStorageConfigurationRequest - ResourceNotFoundExceptionValidationExceptionAccessDeniedExceptionInternalServerExceptionServiceQuotaExceededExceptionConflictExceptionImportPublicKeyResult importPublicKey(ImportPublicKeyRequest importPublicKeyRequest)
Import a public key to be used for signing stage participant tokens.
importPublicKeyRequest - ValidationExceptionAccessDeniedExceptionServiceQuotaExceededExceptionConflictExceptionPendingVerificationExceptionListCompositionsResult listCompositions(ListCompositionsRequest listCompositionsRequest)
Gets summary information about all Compositions in your account, in the AWS region where the API request is processed.
listCompositionsRequest - ValidationExceptionAccessDeniedExceptionInternalServerExceptionServiceQuotaExceededExceptionConflictExceptionListEncoderConfigurationsResult listEncoderConfigurations(ListEncoderConfigurationsRequest listEncoderConfigurationsRequest)
Gets summary information about all EncoderConfigurations in your account, in the AWS region where the API request is processed.
listEncoderConfigurationsRequest - ValidationExceptionAccessDeniedExceptionInternalServerExceptionServiceQuotaExceededExceptionConflictExceptionListParticipantEventsResult listParticipantEvents(ListParticipantEventsRequest listParticipantEventsRequest)
Lists events for a specified participant that occurred during a specified stage session.
listParticipantEventsRequest - ValidationExceptionAccessDeniedExceptionListParticipantsResult listParticipants(ListParticipantsRequest listParticipantsRequest)
Lists all participants in a specified stage session.
listParticipantsRequest - ValidationExceptionAccessDeniedExceptionListPublicKeysResult listPublicKeys(ListPublicKeysRequest listPublicKeysRequest)
Gets summary information about all public keys in your account, in the AWS region where the API request is processed.
listPublicKeysRequest - ValidationExceptionAccessDeniedExceptionListStageSessionsResult listStageSessions(ListStageSessionsRequest listStageSessionsRequest)
Gets all sessions for a specified stage.
listStageSessionsRequest - ValidationExceptionAccessDeniedExceptionListStagesResult listStages(ListStagesRequest listStagesRequest)
Gets summary information about all stages in your account, in the AWS region where the API request is processed.
listStagesRequest - ValidationExceptionAccessDeniedExceptionConflictExceptionListStorageConfigurationsResult listStorageConfigurations(ListStorageConfigurationsRequest listStorageConfigurationsRequest)
Gets summary information about all storage configurations in your account, in the AWS region where the API request is processed.
listStorageConfigurationsRequest - ValidationExceptionAccessDeniedExceptionInternalServerExceptionServiceQuotaExceededExceptionConflictExceptionListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Gets information about AWS tags for the specified ARN.
listTagsForResourceRequest - ResourceNotFoundExceptionValidationExceptionInternalServerExceptionStartCompositionResult startComposition(StartCompositionRequest startCompositionRequest)
Starts a Composition from a stage based on the configuration provided in the request.
A Composition is an ephemeral resource that exists after this endpoint returns successfully. Composition stops and the resource is deleted:
When StopComposition is called.
After a 1-minute timeout, when all participants are disconnected from the stage.
After a 1-minute timeout, if there are no participants in the stage when StartComposition is called.
When broadcasting to the IVS channel fails and all retries are exhausted.
When broadcasting is disconnected and all attempts to reconnect are exhausted.
startCompositionRequest - ResourceNotFoundExceptionValidationExceptionAccessDeniedExceptionInternalServerExceptionServiceQuotaExceededExceptionConflictExceptionPendingVerificationExceptionStopCompositionResult stopComposition(StopCompositionRequest stopCompositionRequest)
Stops and deletes a Composition resource. Any broadcast from the Composition resource is stopped.
stopCompositionRequest - ResourceNotFoundExceptionValidationExceptionAccessDeniedExceptionInternalServerExceptionServiceQuotaExceededExceptionConflictExceptionTagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Adds or updates tags for the AWS resource with the specified ARN.
tagResourceRequest - ResourceNotFoundExceptionValidationExceptionInternalServerExceptionUntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from the resource with the specified ARN.
untagResourceRequest - ResourceNotFoundExceptionValidationExceptionInternalServerExceptionUpdateStageResult updateStage(UpdateStageRequest updateStageRequest)
Updates a stage’s configuration.
updateStageRequest - ResourceNotFoundExceptionValidationExceptionAccessDeniedExceptionServiceQuotaExceededExceptionConflictExceptionPendingVerificationExceptionvoid shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
request - The originally executed request.