com.amazonaws.services.ivsrealtime

Class AbstractAmazonIVSRealTime

java.lang.Object

com.amazonaws.services.ivsrealtime.AbstractAmazonIVSRealTime

All Implemented Interfaces:

AmazonIVSRealTime

Direct Known Subclasses:

AbstractAmazonIVSRealTimeAsync

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAmazonIVSRealTime
extends Object
implements AmazonIVSRealTime

Abstract implementation of AmazonIVSRealTime. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary

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

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
CreateEncoderConfigurationResult	createEncoderConfiguration(CreateEncoderConfigurationRequest request) Creates an EncoderConfiguration object.
CreateParticipantTokenResult	createParticipantToken(CreateParticipantTokenRequest request) Creates an additional token for a specified stage.
CreateStageResult	createStage(CreateStageRequest request) Creates a new stage (and optionally participant tokens).
CreateStorageConfigurationResult	createStorageConfiguration(CreateStorageConfigurationRequest request) Creates a new storage configuration, used to enable recording to Amazon S3.
DeleteEncoderConfigurationResult	deleteEncoderConfiguration(DeleteEncoderConfigurationRequest request) Deletes an EncoderConfiguration resource.
DeletePublicKeyResult	deletePublicKey(DeletePublicKeyRequest request) Deletes the specified public key used to sign stage participant tokens.
DeleteStageResult	deleteStage(DeleteStageRequest request) Shuts down and deletes the specified stage (disconnecting all participants).
DeleteStorageConfigurationResult	deleteStorageConfiguration(DeleteStorageConfigurationRequest request) Deletes the storage configuration for the specified ARN.
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.
GetCompositionResult	getComposition(GetCompositionRequest request) Get information about the specified Composition resource.
GetEncoderConfigurationResult	getEncoderConfiguration(GetEncoderConfigurationRequest request) Gets information about the specified EncoderConfiguration resource.
GetParticipantResult	getParticipant(GetParticipantRequest request) Gets information about the specified participant token.
GetPublicKeyResult	getPublicKey(GetPublicKeyRequest request) Gets information for the specified public key.
GetStageResult	getStage(GetStageRequest request) Gets information for the specified stage.
GetStageSessionResult	getStageSession(GetStageSessionRequest request) Gets information for the specified stage session.
GetStorageConfigurationResult	getStorageConfiguration(GetStorageConfigurationRequest request) Gets the storage configuration for the specified ARN.
ImportPublicKeyResult	importPublicKey(ImportPublicKeyRequest request) Import a public key to be used for signing stage participant tokens.
ListCompositionsResult	listCompositions(ListCompositionsRequest request) Gets summary information about all Compositions in your account, in the AWS region where the API request is processed.
ListEncoderConfigurationsResult	listEncoderConfigurations(ListEncoderConfigurationsRequest request) Gets summary information about all EncoderConfigurations in your account, in the AWS region where the API request is processed.
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.
ListPublicKeysResult	listPublicKeys(ListPublicKeysRequest request) Gets summary information about all public keys in your account, in the AWS region where the API request is processed.
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.
ListStorageConfigurationsResult	listStorageConfigurations(ListStorageConfigurationsRequest request) Gets summary information about all storage configurations in your account, in the AWS region where the API request is processed.
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.
StartCompositionResult	startComposition(StartCompositionRequest request) Starts a Composition from a stage based on the configuration provided in the request.
StopCompositionResult	stopComposition(StopCompositionRequest request) Stops and deletes a Composition resource.
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

createEncoderConfiguration

public CreateEncoderConfigurationResult createEncoderConfiguration(CreateEncoderConfigurationRequest request)

Description copied from interface: AmazonIVSRealTime

Creates an EncoderConfiguration object.

Specified by:

createEncoderConfiguration in interface AmazonIVSRealTime

Returns:

Result of the CreateEncoderConfiguration operation returned by the service.

See Also:

AWS API Documentation

createParticipantToken

public CreateParticipantTokenResult createParticipantToken(CreateParticipantTokenRequest request)

Description copied from interface: AmazonIVSRealTime

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

Returns:

Result of the CreateParticipantToken operation returned by the service.

See Also:

AWS API Documentation

createStage

public CreateStageResult createStage(CreateStageRequest request)

Description copied from interface: AmazonIVSRealTime

Creates a new stage (and optionally participant tokens).

Specified by:

createStage in interface AmazonIVSRealTime

Returns:

Result of the CreateStage operation returned by the service.

See Also:

AWS API Documentation

createStorageConfiguration

public CreateStorageConfigurationResult createStorageConfiguration(CreateStorageConfigurationRequest request)

Description copied from interface: AmazonIVSRealTime

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.

Specified by:

createStorageConfiguration in interface AmazonIVSRealTime

Returns:

Result of the CreateStorageConfiguration operation returned by the service.

See Also:

AWS API Documentation

deleteEncoderConfiguration

public DeleteEncoderConfigurationResult deleteEncoderConfiguration(DeleteEncoderConfigurationRequest request)

Description copied from interface: AmazonIVSRealTime

Deletes an EncoderConfiguration resource. Ensures that no Compositions are using this template; otherwise, returns an error.

Specified by:

deleteEncoderConfiguration in interface AmazonIVSRealTime

Returns:

Result of the DeleteEncoderConfiguration operation returned by the service.

See Also:

AWS API Documentation

deletePublicKey

public DeletePublicKeyResult deletePublicKey(DeletePublicKeyRequest request)

Description copied from interface: AmazonIVSRealTime

Deletes the specified public key used to sign stage participant tokens. This invalidates future participant tokens generated using the key pair’s private key.

Specified by:

deletePublicKey in interface AmazonIVSRealTime

Returns:

Result of the DeletePublicKey operation returned by the service.

See Also:

AWS API Documentation

deleteStage

public DeleteStageResult deleteStage(DeleteStageRequest request)

Description copied from interface: AmazonIVSRealTime

Shuts down and deletes the specified stage (disconnecting all participants).

Specified by:

deleteStage in interface AmazonIVSRealTime

Returns:

Result of the DeleteStage operation returned by the service.

See Also:

AWS API Documentation

deleteStorageConfiguration

public DeleteStorageConfigurationResult deleteStorageConfiguration(DeleteStorageConfigurationRequest request)

Description copied from interface: AmazonIVSRealTime

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.

Specified by:

deleteStorageConfiguration in interface AmazonIVSRealTime

Returns:

Result of the DeleteStorageConfiguration operation returned by the service.

See Also:

AWS API Documentation

disconnectParticipant

public DisconnectParticipantResult disconnectParticipant(DisconnectParticipantRequest request)

Description copied from interface: AmazonIVSRealTime

Disconnects a specified participant and revokes the participant permanently from a specified stage.

Specified by:

disconnectParticipant in interface AmazonIVSRealTime

Returns:

Result of the DisconnectParticipant operation returned by the service.

See Also:

AWS API Documentation

getComposition

public GetCompositionResult getComposition(GetCompositionRequest request)

Description copied from interface: AmazonIVSRealTime

Get information about the specified Composition resource.

Specified by:

getComposition in interface AmazonIVSRealTime

Returns:

Result of the GetComposition operation returned by the service.

See Also:

AWS API Documentation

getEncoderConfiguration

public GetEncoderConfigurationResult getEncoderConfiguration(GetEncoderConfigurationRequest request)

Description copied from interface: AmazonIVSRealTime

Gets information about the specified EncoderConfiguration resource.

Specified by:

getEncoderConfiguration in interface AmazonIVSRealTime

Returns:

Result of the GetEncoderConfiguration operation returned by the service.

See Also:

AWS API Documentation

getParticipant

public GetParticipantResult getParticipant(GetParticipantRequest request)

Description copied from interface: AmazonIVSRealTime

Gets information about the specified participant token.

Specified by:

getParticipant in interface AmazonIVSRealTime

Returns:

Result of the GetParticipant operation returned by the service.

See Also:

AWS API Documentation

getPublicKey

public GetPublicKeyResult getPublicKey(GetPublicKeyRequest request)

Description copied from interface: AmazonIVSRealTime

Gets information for the specified public key.

Specified by:

getPublicKey in interface AmazonIVSRealTime

Returns:

Result of the GetPublicKey operation returned by the service.

See Also:

AWS API Documentation

getStage

public GetStageResult getStage(GetStageRequest request)

Description copied from interface: AmazonIVSRealTime

Gets information for the specified stage.

Specified by:

getStage in interface AmazonIVSRealTime

Returns:

Result of the GetStage operation returned by the service.

See Also:

AWS API Documentation

getStageSession

public GetStageSessionResult getStageSession(GetStageSessionRequest request)

Description copied from interface: AmazonIVSRealTime

Gets information for the specified stage session.

Specified by:

getStageSession in interface AmazonIVSRealTime

Returns:

Result of the GetStageSession operation returned by the service.

See Also:

AWS API Documentation

getStorageConfiguration

public GetStorageConfigurationResult getStorageConfiguration(GetStorageConfigurationRequest request)

Description copied from interface: AmazonIVSRealTime

Gets the storage configuration for the specified ARN.

Specified by:

getStorageConfiguration in interface AmazonIVSRealTime

Returns:

Result of the GetStorageConfiguration operation returned by the service.

See Also:

AWS API Documentation

importPublicKey

public ImportPublicKeyResult importPublicKey(ImportPublicKeyRequest request)

Description copied from interface: AmazonIVSRealTime

Import a public key to be used for signing stage participant tokens.

Specified by:

importPublicKey in interface AmazonIVSRealTime

Returns:

Result of the ImportPublicKey operation returned by the service.

See Also:

AWS API Documentation

listCompositions

public ListCompositionsResult listCompositions(ListCompositionsRequest request)

Description copied from interface: AmazonIVSRealTime

Gets summary information about all Compositions in your account, in the AWS region where the API request is processed.

Specified by:

listCompositions in interface AmazonIVSRealTime

Returns:

Result of the ListCompositions operation returned by the service.

See Also:

AWS API Documentation

listEncoderConfigurations

public ListEncoderConfigurationsResult listEncoderConfigurations(ListEncoderConfigurationsRequest request)

Description copied from interface: AmazonIVSRealTime

Gets summary information about all EncoderConfigurations in your account, in the AWS region where the API request is processed.

Specified by:

listEncoderConfigurations in interface AmazonIVSRealTime

Returns:

Result of the ListEncoderConfigurations operation returned by the service.

See Also:

AWS API Documentation

listParticipantEvents

public ListParticipantEventsResult listParticipantEvents(ListParticipantEventsRequest request)

Description copied from interface: AmazonIVSRealTime

Lists events for a specified participant that occurred during a specified stage session.

Specified by:

listParticipantEvents in interface AmazonIVSRealTime

Returns:

Result of the ListParticipantEvents operation returned by the service.

See Also:

AWS API Documentation

listParticipants

public ListParticipantsResult listParticipants(ListParticipantsRequest request)

Description copied from interface: AmazonIVSRealTime

Lists all participants in a specified stage session.

Specified by:

listParticipants in interface AmazonIVSRealTime

Returns:

Result of the ListParticipants operation returned by the service.

See Also:

AWS API Documentation

listPublicKeys

public ListPublicKeysResult listPublicKeys(ListPublicKeysRequest request)

Description copied from interface: AmazonIVSRealTime

Gets summary information about all public keys in your account, in the AWS region where the API request is processed.

Specified by:

listPublicKeys in interface AmazonIVSRealTime

Returns:

Result of the ListPublicKeys operation returned by the service.

See Also:

AWS API Documentation

listStageSessions

public ListStageSessionsResult listStageSessions(ListStageSessionsRequest request)

Description copied from interface: AmazonIVSRealTime

Gets all sessions for a specified stage.

Specified by:

listStageSessions in interface AmazonIVSRealTime

Returns:

Result of the ListStageSessions operation returned by the service.

See Also:

AWS API Documentation

listStages

public ListStagesResult listStages(ListStagesRequest request)

Description copied from interface: AmazonIVSRealTime

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

Returns:

Result of the ListStages operation returned by the service.

See Also:

AWS API Documentation

listStorageConfigurations

public ListStorageConfigurationsResult listStorageConfigurations(ListStorageConfigurationsRequest request)

Description copied from interface: AmazonIVSRealTime

Gets summary information about all storage configurations in your account, in the AWS region where the API request is processed.

Specified by:

listStorageConfigurations in interface AmazonIVSRealTime

Returns:

Result of the ListStorageConfigurations operation returned by the service.

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Description copied from interface: AmazonIVSRealTime

Gets information about AWS tags for the specified ARN.

Specified by:

listTagsForResource in interface AmazonIVSRealTime

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

AWS API Documentation

startComposition

public StartCompositionResult startComposition(StartCompositionRequest request)

Description copied from interface: AmazonIVSRealTime

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.

Specified by:

startComposition in interface AmazonIVSRealTime

Returns:

Result of the StartComposition operation returned by the service.

See Also:

AWS API Documentation

stopComposition

public StopCompositionResult stopComposition(StopCompositionRequest request)

Description copied from interface: AmazonIVSRealTime

Stops and deletes a Composition resource. Any broadcast from the Composition resource is stopped.

Specified by:

stopComposition in interface AmazonIVSRealTime

Returns:

Result of the StopComposition operation returned by the service.

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

Description copied from interface: AmazonIVSRealTime

Adds or updates tags for the AWS resource with the specified ARN.

Specified by:

tagResource in interface AmazonIVSRealTime

Returns:

Result of the TagResource operation returned by the service.

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Description copied from interface: AmazonIVSRealTime

Removes tags from the resource with the specified ARN.

Specified by:

untagResource in interface AmazonIVSRealTime

Returns:

Result of the UntagResource operation returned by the service.

See Also:

AWS API Documentation

updateStage

public UpdateStageResult updateStage(UpdateStageRequest request)

Description copied from interface: AmazonIVSRealTime

Updates a stage’s configuration.

Specified by:

updateStage in interface AmazonIVSRealTime

Returns:

Result of the UpdateStage operation returned by the service.

See Also:

AWS API Documentation

shutdown

public void shutdown()

Description copied from interface: AmazonIVSRealTime

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.

Specified by:

shutdown in interface AmazonIVSRealTime

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Description copied from interface: AmazonIVSRealTime

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.

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.