AmazonIVSClient (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceClient
- - com.amazonaws.services.ivs.AmazonIVSClient

All Implemented Interfaces:: AmazonIVS

Direct Known Subclasses:: AmazonIVSAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonIVSClient
extends AmazonWebServiceClient
implements AmazonIVS

Client for accessing Amazon IVS. 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) API is REST compatible, using a standard HTTP API and an Amazon Web Services EventBridge event stream for responses. JSON is used for both requests and responses, including errors.

The API is an Amazon Web Services regional service. For a list of supported regions and Amazon IVS HTTPS service endpoints, see the Amazon IVS page in the Amazon Web Services General Reference.

All API request parameters and URLs are case sensitive.

For a summary of notable documentation changes in each release, see Document History.

  <p> <b>Allowed Header Values</b> </p> <ul> <li> <p> <code> <b>Accept:</b> </code> application/json</p> </li> <li> <p> <code> <b>Accept-Encoding:</b> </code> gzip, deflate</p> </li> <li> <p> <code> <b>Content-Type:</b> </code>application/json</p> </li> </ul> <p> <b>Resources</b> </p> <p>The following resources contain information about your IVS live stream (see <a href="https://docs.aws.amazon.com/ivs/latest/userguide/getting-started.html"> Getting Started with Amazon IVS</a>):</p> <ul> <li> <p>Channel — Stores configuration data related to your live stream. You first create a channel and then use the channel’s stream key to start your live stream. See the Channel endpoints for more information. </p> </li> <li> <p>Stream key — An identifier assigned by Amazon IVS when you create a channel, which is then used to authorize streaming. See the StreamKey endpoints for more information. <i> <b>Treat the stream key like a secret, since it allows anyone to stream to the channel.</b> </i> </p> </li> <li> <p>Playback key pair — Video playback may be restricted using playback-authorization tokens, which use public-key encryption. A playback key pair is the public-private pair of keys used to sign and validate the playback-authorization token. See the PlaybackKeyPair endpoints for more information.</p> </li> <li> <p>Recording configuration — Stores configuration related to recording a live stream and where to store the recorded content. Multiple channels can reference the same recording configuration. See the Recording Configuration endpoints for more information.</p> </li> </ul> <p> <b>Tagging</b> </p> <p>A <i>tag</i> is a metadata label that you assign to an Amazon Web Services resource. A tag comprises a <i>key</i> and a <i>value</i>, both set by you. For example, you might set a tag as <code>topic:nature</code> to label a particular video category. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a> for more information, including restrictions that apply to tags.</p> <p>Tags can help you identify and organize your Amazon Web Services 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 <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html"> Access Tags</a>). </p> <p>The Amazon IVS API has these tag-related endpoints: <a>TagResource</a>, <a>UntagResource</a>, and <a>ListTagsForResource</a>. The following resources support tagging: Channels, Stream Keys, Playback Key Pairs, and Recording Configurations.</p> <p>At most 50 tags can be applied to a resource. </p> <p> <b>Authentication versus Authorization</b> </p> <p>Note the differences between these concepts:</p> <ul> <li> <p> <i>Authentication</i> is about verifying identity. You need to be authenticated to sign Amazon IVS API requests.</p> </li> <li> <p> <i>Authorization</i> is about granting permissions. You need to be authorized to view <a href="https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html">Amazon IVS private channels</a>. (Private channels are channels that are enabled for "playback authorization.")</p> </li> </ul> <p> <b>Authentication</b> </p> <p>All Amazon IVS API requests must be authenticated with a signature. The Amazon Web Services Command-Line Interface (CLI) and Amazon IVS Player SDKs take care of signing the underlying API calls for you. However, if your application calls the Amazon IVS API directly, it’s your responsibility to sign the requests.</p> <p>You generate a signature using valid Amazon Web Services credentials that have permission to perform the requested action. For example, you must sign PutMetadata requests with a signature generated from an IAM user account that has the <code>ivs:PutMetadata</code> permission.</p> <p>For more information:</p> <ul> <li> <p>Authentication and generating signatures — See <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html">Authenticating Requests (Amazon Web Services Signature Version 4)</a> in the <i>Amazon Web Services General Reference</i>.</p> </li> <li> <p>Managing Amazon IVS permissions — See <a href="https://docs.aws.amazon.com/ivs/latest/userguide/security-iam.html">Identity and Access Management</a> on the Security page of the <i>Amazon IVS User Guide</i>.</p> </li> </ul> <p> <b>Channel Endpoints</b> </p> <ul> <li> <p> <a>CreateChannel</a> — Creates a new channel and an associated stream key to start streaming.</p> </li> <li> <p> <a>GetChannel</a> — Gets the channel configuration for the specified channel ARN (Amazon Resource Name).</p> </li> <li> <p> <a>BatchGetChannel</a> — Performs <a>GetChannel</a> on multiple ARNs simultaneously.</p> </li> <li> <p> <a>ListChannels</a> — Gets summary information about all channels in your account, in the Amazon Web Services region where the API request is processed. This list can be filtered to match a specified name or recording-configuration ARN. Filters are mutually exclusive and cannot be used together. If you try to use both filters, you will get an error (409 Conflict Exception).</p> </li> <li> <p> <a>UpdateChannel</a> — Updates a channel's configuration. This does not affect an ongoing stream of this channel. You must stop and restart the stream for the changes to take effect.</p> </li> <li> <p> <a>DeleteChannel</a> — Deletes the specified channel.</p> </li> </ul> <p> <b>StreamKey Endpoints</b> </p> <ul> <li> <p> <a>CreateStreamKey</a> — Creates a stream key, used to initiate a stream, for the specified channel ARN.</p> </li> <li> <p> <a>GetStreamKey</a> — Gets stream key information for the specified ARN.</p> </li> <li> <p> <a>BatchGetStreamKey</a> — Performs <a>GetStreamKey</a> on multiple ARNs simultaneously.</p> </li> <li> <p> <a>ListStreamKeys</a> — Gets summary information about stream keys for the specified channel.</p> </li> <li> <p> <a>DeleteStreamKey</a> — Deletes the stream key for the specified ARN, so it can no longer be used to stream.</p> </li> </ul> <p> <b>Stream Endpoints</b> </p> <ul> <li> <p> <a>GetStream</a> — Gets information about the active (live) stream on a specified channel.</p> </li> <li> <p> <a>ListStreams</a> — Gets summary information about live streams in your account, in the Amazon Web Services region where the API request is processed.</p> </li> <li> <p> <a>StopStream</a> — Disconnects the incoming RTMPS stream for the specified channel. Can be used in conjunction with <a>DeleteStreamKey</a> to prevent further streaming to a channel.</p> </li> <li> <p> <a>PutMetadata</a> — Inserts metadata into the active stream of the specified channel. At most 5 requests per second per channel are allowed, each with a maximum 1 KB payload. (If 5 TPS is not sufficient for your needs, we recommend batching your data into a single PutMetadata call.) At most 155 requests per second per account are allowed.</p> </li> </ul> <p> <b>PlaybackKeyPair Endpoints</b> </p> <p>For more information, see <a href="https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html">Setting Up Private Channels</a> in the <i>Amazon IVS User Guide</i>.</p> <ul> <li> <p> <a>ImportPlaybackKeyPair</a> — Imports the public portion of a new key pair and returns its <code>arn</code> and <code>fingerprint</code>. The <code>privateKey</code> can then be used to generate viewer authorization tokens, to grant viewers access to private channels (channels enabled for playback authorization).</p> </li> <li> <p> <a>GetPlaybackKeyPair</a> — Gets a specified playback authorization key pair and returns the <code>arn</code> and <code>fingerprint</code>. The <code>privateKey</code> held by the caller can be used to generate viewer authorization tokens, to grant viewers access to private channels.</p> </li> <li> <p> <a>ListPlaybackKeyPairs</a> — Gets summary information about playback key pairs.</p> </li> <li> <p> <a>DeletePlaybackKeyPair</a> — Deletes a specified authorization key pair. This invalidates future viewer tokens generated using the key pair’s <code>privateKey</code>.</p> </li> </ul> <p> <b>RecordingConfiguration Endpoints</b> </p> <ul> <li> <p> <a>CreateRecordingConfiguration</a> — Creates a new recording configuration, used to enable recording to Amazon S3.</p> </li> <li> <p> <a>GetRecordingConfiguration</a> — Gets the recording-configuration metadata for the specified ARN.</p> </li> <li> <p> <a>ListRecordingConfigurations</a> — Gets summary information about all recording configurations in your account, in the Amazon Web Services region where the API request is processed.</p> </li> <li> <p> <a>DeleteRecordingConfiguration</a> — Deletes the recording configuration for the specified ARN.</p> </li> </ul> <p> <b>Amazon Web Services Tags Endpoints</b> </p> <ul> <li> <p> <a>TagResource</a> — Adds or updates tags for the Amazon Web Services resource with the specified ARN.</p> </li> <li> <p> <a>UntagResource</a> — Removes tags from the resource with the specified ARN.</p> </li> <li> <p> <a>ListTagsForResource</a> — Gets information about Amazon Web Services tags for the specified ARN.</p> </li> </ul>

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceClient
  LOGGING_AWS_REQUEST_METRIC
- Fields inherited from interface com.amazonaws.services.ivs.AmazonIVS
  ENDPOINT_PREFIX

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BatchGetChannelResult`	`batchGetChannel(BatchGetChannelRequest request)` Performs GetChannel on multiple ARNs simultaneously.
`BatchGetStreamKeyResult`	`batchGetStreamKey(BatchGetStreamKeyRequest request)` Performs GetStreamKey on multiple ARNs simultaneously.
`static AmazonIVSClientBuilder`	`builder()`
`CreateChannelResult`	`createChannel(CreateChannelRequest request)` Creates a new channel and an associated stream key to start streaming.
`CreateRecordingConfigurationResult`	`createRecordingConfiguration(CreateRecordingConfigurationRequest request)` Creates a new recording configuration, used to enable recording to Amazon S3.
`CreateStreamKeyResult`	`createStreamKey(CreateStreamKeyRequest request)` Creates a stream key, used to initiate a stream, for the specified channel ARN.
`DeleteChannelResult`	`deleteChannel(DeleteChannelRequest request)` Deletes the specified channel and its associated stream keys.
`DeletePlaybackKeyPairResult`	`deletePlaybackKeyPair(DeletePlaybackKeyPairRequest request)` Deletes a specified authorization key pair.
`DeleteRecordingConfigurationResult`	`deleteRecordingConfiguration(DeleteRecordingConfigurationRequest request)` Deletes the recording configuration for the specified ARN.
`DeleteStreamKeyResult`	`deleteStreamKey(DeleteStreamKeyRequest request)` Deletes the stream key for the specified ARN, so it can no longer be used to stream.
`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.
`GetChannelResult`	`getChannel(GetChannelRequest request)` Gets the channel configuration for the specified channel ARN.
`GetPlaybackKeyPairResult`	`getPlaybackKeyPair(GetPlaybackKeyPairRequest request)` Gets a specified playback authorization key pair and returns the `arn` and `fingerprint`.
`GetRecordingConfigurationResult`	`getRecordingConfiguration(GetRecordingConfigurationRequest request)` Gets the recording configuration for the specified ARN.
`GetStreamResult`	`getStream(GetStreamRequest request)` Gets information about the active (live) stream on a specified channel.
`GetStreamKeyResult`	`getStreamKey(GetStreamKeyRequest request)` Gets stream-key information for a specified ARN.
`ImportPlaybackKeyPairResult`	`importPlaybackKeyPair(ImportPlaybackKeyPairRequest request)` Imports the public portion of a new key pair and returns its `arn` and `fingerprint`.
`ListChannelsResult`	`listChannels(ListChannelsRequest request)` Gets summary information about all channels in your account, in the Amazon Web Services region where the API request is processed.
`ListPlaybackKeyPairsResult`	`listPlaybackKeyPairs(ListPlaybackKeyPairsRequest request)` Gets summary information about playback key pairs.
`ListRecordingConfigurationsResult`	`listRecordingConfigurations(ListRecordingConfigurationsRequest request)` Gets summary information about all recording configurations in your account, in the Amazon Web Services region where the API request is processed.
`ListStreamKeysResult`	`listStreamKeys(ListStreamKeysRequest request)` Gets summary information about stream keys for the specified channel.
`ListStreamsResult`	`listStreams(ListStreamsRequest request)` Gets summary information about live streams in your account, in the Amazon Web Services region where the API request is processed.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` Gets information about Amazon Web Services tags for the specified ARN.
`PutMetadataResult`	`putMetadata(PutMetadataRequest request)` Inserts metadata into the active stream of the specified channel.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`StopStreamResult`	`stopStream(StopStreamRequest request)` Disconnects the incoming RTMPS stream for the specified channel.
`TagResourceResult`	`tagResource(TagResourceRequest request)` Adds or updates tags for the Amazon Web Services resource with the specified ARN.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Removes tags from the resource with the specified ARN.
`UpdateChannelResult`	`updateChannel(UpdateChannelRequest request)` Updates a channel's configuration.

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

- Method Detail
  - builder
```
public static AmazonIVSClientBuilder builder()
```
  - batchGetChannel
```
public BatchGetChannelResult batchGetChannel(BatchGetChannelRequest request)
```
    Performs GetChannel on multiple ARNs simultaneously.
    
    Specified by:
    
    batchGetChannel in interface AmazonIVS
    
    Parameters:
    
    batchGetChannelRequest -
    
    Returns:
    
    Result of the BatchGetChannel operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - batchGetStreamKey
```
public BatchGetStreamKeyResult batchGetStreamKey(BatchGetStreamKeyRequest request)
```
    Performs GetStreamKey on multiple ARNs simultaneously.
    
    Specified by:
    
    batchGetStreamKey in interface AmazonIVS
    
    Parameters:
    
    batchGetStreamKeyRequest -
    
    Returns:
    
    Result of the BatchGetStreamKey operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createChannel
```
public CreateChannelResult createChannel(CreateChannelRequest request)
```
    Creates a new channel and an associated stream key to start streaming.
    
    Specified by:
    
    createChannel in interface AmazonIVS
    
    Parameters:
    
    createChannelRequest -
    
    Returns:
    
    Result of the CreateChannel operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException
    
    AccessDeniedException
    
    ValidationException
    
    PendingVerificationException
    
    ServiceQuotaExceededException
    
    See Also:
    
    AWS API Documentation
  - createRecordingConfiguration
```
public CreateRecordingConfigurationResult createRecordingConfiguration(CreateRecordingConfigurationRequest request)
```
    Creates a new recording configuration, used to enable recording to Amazon S3.
    
    Known issue: In the us-east-1 region, if you use the Amazon Web Services CLI to create a recording configuration, it returns success even if the S3 bucket is in a different region. In this case, the state of the recording configuration is CREATE_FAILED (instead of ACTIVE). (In other regions, the CLI correctly returns failure if the bucket is in a different region.)
    
    Workaround: Ensure that your S3 bucket is in the same region as the recording configuration. If you create a recording configuration in a different region as your S3 bucket, delete that recording configuration and create a new one with an S3 bucket from the correct region.
    
    Specified by:
    
    createRecordingConfiguration in interface AmazonIVS
    
    Parameters:
    
    createRecordingConfigurationRequest -
    
    Returns:
    
    Result of the CreateRecordingConfiguration operation returned by the service.
    
    Throws:
    
    InternalServerException
    
    AccessDeniedException
    
    ValidationException
    
    PendingVerificationException
    
    ConflictException
    
    ServiceQuotaExceededException
    
    See Also:
    
    AWS API Documentation
  - createStreamKey
```
public CreateStreamKeyResult createStreamKey(CreateStreamKeyRequest request)
```
    Creates a stream key, used to initiate a stream, for the specified channel ARN.
    
    Note that CreateChannel creates a stream key. If you subsequently use CreateStreamKey on the same channel, it will fail because a stream key already exists and there is a limit of 1 stream key per channel. To reset the stream key on a channel, use DeleteStreamKey and then CreateStreamKey.
    
    Specified by:
    
    createStreamKey in interface AmazonIVS
    
    Parameters:
    
    createStreamKeyRequest -
    
    Returns:
    
    Result of the CreateStreamKey operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException
    
    AccessDeniedException
    
    ValidationException
    
    PendingVerificationException
    
    ServiceQuotaExceededException
    
    See Also:
    
    AWS API Documentation
  - deleteChannel
```
public DeleteChannelResult deleteChannel(DeleteChannelRequest request)
```
    Deletes the specified channel and its associated stream keys.
    
    If you try to delete a live channel, you will get an error (409 ConflictException). To delete a channel that is live, call StopStream, wait for the Amazon EventBridge "Stream End" event (to verify that the stream's state was changed from Live to Offline), then call DeleteChannel. (See Using EventBridge with Amazon IVS.)
    
    Specified by:
    
    deleteChannel in interface AmazonIVS
    
    Parameters:
    
    deleteChannelRequest -
    
    Returns:
    
    Result of the DeleteChannel operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException
    
    AccessDeniedException
    
    ValidationException
    
    PendingVerificationException
    
    ConflictException
    
    See Also:
    
    AWS API Documentation
  - deletePlaybackKeyPair
```
public DeletePlaybackKeyPairResult deletePlaybackKeyPair(DeletePlaybackKeyPairRequest request)
```
    Deletes a specified authorization key pair. This invalidates future viewer tokens generated using the key pair’s privateKey. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.
    
    Specified by:
    
    deletePlaybackKeyPair in interface AmazonIVS
    
    Parameters:
    
    deletePlaybackKeyPairRequest -
    
    Returns:
    
    Result of the DeletePlaybackKeyPair operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException
    
    AccessDeniedException
    
    ValidationException
    
    PendingVerificationException
    
    See Also:
    
    AWS API Documentation
  - deleteRecordingConfiguration
```
public DeleteRecordingConfigurationResult deleteRecordingConfiguration(DeleteRecordingConfigurationRequest request)
```
    Deletes the recording configuration for the specified ARN.
    
    If you try to delete a recording configuration that is associated with a channel, you will get an error (409 ConflictException). To avoid this, for all channels that reference the recording configuration, first use UpdateChannel to set the recordingConfigurationArn field to an empty string, then use DeleteRecordingConfiguration.
    
    Specified by:
    
    deleteRecordingConfiguration in interface AmazonIVS
    
    Parameters:
    
    deleteRecordingConfigurationRequest -
    
    Returns:
    
    Result of the DeleteRecordingConfiguration operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException
    
    InternalServerException
    
    AccessDeniedException
    
    ValidationException
    
    ConflictException
    
    See Also:
    
    AWS API Documentation
  - deleteStreamKey
```
public DeleteStreamKeyResult deleteStreamKey(DeleteStreamKeyRequest request)
```
    Deletes the stream key for the specified ARN, so it can no longer be used to stream.
    
    Specified by:
    
    deleteStreamKey in interface AmazonIVS
    
    Parameters:
    
    deleteStreamKeyRequest -
    
    Returns:
    
    Result of the DeleteStreamKey operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException
    
    AccessDeniedException
    
    ValidationException
    
    PendingVerificationException
    
    See Also:
    
    AWS API Documentation
  - getChannel
```
public GetChannelResult getChannel(GetChannelRequest request)
```
    Gets the channel configuration for the specified channel ARN. See also BatchGetChannel.
    
    Specified by:
    
    getChannel in interface AmazonIVS
    
    Parameters:
    
    getChannelRequest -
    
    Returns:
    
    Result of the GetChannel operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException
    
    AccessDeniedException
    
    ValidationException
    
    See Also:
    
    AWS API Documentation
  - getPlaybackKeyPair
```
public GetPlaybackKeyPairResult getPlaybackKeyPair(GetPlaybackKeyPairRequest request)
```
    Gets a specified playback authorization key pair and returns the arn and fingerprint. The privateKey held by the caller can be used to generate viewer authorization tokens, to grant viewers access to private channels. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.
    
    Specified by:
    
    getPlaybackKeyPair in interface AmazonIVS
    
    Parameters:
    
    getPlaybackKeyPairRequest -
    
    Returns:
    
    Result of the GetPlaybackKeyPair operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException
    
    AccessDeniedException
    
    ValidationException
    
    See Also:
    
    AWS API Documentation
  - getRecordingConfiguration
```
public GetRecordingConfigurationResult getRecordingConfiguration(GetRecordingConfigurationRequest request)
```
    Gets the recording configuration for the specified ARN.
    
    Specified by:
    
    getRecordingConfiguration in interface AmazonIVS
    
    Parameters:
    
    getRecordingConfigurationRequest -
    
    Returns:
    
    Result of the GetRecordingConfiguration operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException
    
    InternalServerException
    
    AccessDeniedException
    
    ValidationException
    
    See Also:
    
    AWS API Documentation
  - getStream
```
public GetStreamResult getStream(GetStreamRequest request)
```
    Gets information about the active (live) stream on a specified channel.
    
    Specified by:
    
    getStream in interface AmazonIVS
    
    Parameters:
    
    getStreamRequest -
    
    Returns:
    
    Result of the GetStream operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException
    
    AccessDeniedException
    
    ValidationException
    
    ChannelNotBroadcastingException
    
    See Also:
    
    AWS API Documentation
  - getStreamKey
```
public GetStreamKeyResult getStreamKey(GetStreamKeyRequest request)
```
    Gets stream-key information for a specified ARN.
    
    Specified by:
    
    getStreamKey in interface AmazonIVS
    
    Parameters:
    
    getStreamKeyRequest -
    
    Returns:
    
    Result of the GetStreamKey operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException
    
    AccessDeniedException
    
    ValidationException
    
    See Also:
    
    AWS API Documentation
  - importPlaybackKeyPair
```
public ImportPlaybackKeyPairResult importPlaybackKeyPair(ImportPlaybackKeyPairRequest request)
```
    Imports the public portion of a new key pair and returns its arn and fingerprint. The privateKey can then be used to generate viewer authorization tokens, to grant viewers access to private channels. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.
    
    Specified by:
    
    importPlaybackKeyPair in interface AmazonIVS
    
    Parameters:
    
    importPlaybackKeyPairRequest -
    
    Returns:
    
    Result of the ImportPlaybackKeyPair operation returned by the service.
    
    Throws:
    
    AccessDeniedException
    
    ValidationException
    
    PendingVerificationException
    
    ConflictException
    
    ServiceQuotaExceededException
    
    See Also:
    
    AWS API Documentation
  - listChannels
```
public ListChannelsResult listChannels(ListChannelsRequest request)
```
    Gets summary information about all channels in your account, in the Amazon Web Services region where the API request is processed. This list can be filtered to match a specified name or recording-configuration ARN. Filters are mutually exclusive and cannot be used together. If you try to use both filters, you will get an error (409 ConflictException).
    
    Specified by:
    
    listChannels in interface AmazonIVS
    
    Parameters:
    
    listChannelsRequest -
    
    Returns:
    
    Result of the ListChannels operation returned by the service.
    
    Throws:
    
    AccessDeniedException
    
    ValidationException
    
    ConflictException
    
    See Also:
    
    AWS API Documentation
  - listPlaybackKeyPairs
```
public ListPlaybackKeyPairsResult listPlaybackKeyPairs(ListPlaybackKeyPairsRequest request)
```
    Gets summary information about playback key pairs. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.
    
    Specified by:
    
    listPlaybackKeyPairs in interface AmazonIVS
    
    Parameters:
    
    listPlaybackKeyPairsRequest -
    
    Returns:
    
    Result of the ListPlaybackKeyPairs operation returned by the service.
    
    Throws:
    
    AccessDeniedException
    
    ValidationException
    
    See Also:
    
    AWS API Documentation
  - listRecordingConfigurations
```
public ListRecordingConfigurationsResult listRecordingConfigurations(ListRecordingConfigurationsRequest request)
```
    Gets summary information about all recording configurations in your account, in the Amazon Web Services region where the API request is processed.
    
    Specified by:
    
    listRecordingConfigurations in interface AmazonIVS
    
    Parameters:
    
    listRecordingConfigurationsRequest -
    
    Returns:
    
    Result of the ListRecordingConfigurations operation returned by the service.
    
    Throws:
    
    InternalServerException
    
    AccessDeniedException
    
    ValidationException
    
    See Also:
    
    AWS API Documentation
  - listStreamKeys
```
public ListStreamKeysResult listStreamKeys(ListStreamKeysRequest request)
```
    Gets summary information about stream keys for the specified channel.
    
    Specified by:
    
    listStreamKeys in interface AmazonIVS
    
    Parameters:
    
    listStreamKeysRequest -
    
    Returns:
    
    Result of the ListStreamKeys operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException
    
    AccessDeniedException
    
    ValidationException
    
    See Also:
    
    AWS API Documentation
  - listStreams
```
public ListStreamsResult listStreams(ListStreamsRequest request)
```
    Gets summary information about live streams in your account, in the Amazon Web Services region where the API request is processed.
    
    Specified by:
    
    listStreams in interface AmazonIVS
    
    Parameters:
    
    listStreamsRequest -
    
    Returns:
    
    Result of the ListStreams operation returned by the service.
    
    Throws:
    
    AccessDeniedException
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Gets information about Amazon Web Services tags for the specified ARN.
    
    Specified by:
    
    listTagsForResource in interface AmazonIVS
    
    Parameters:
    
    listTagsForResourceRequest -
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException
    
    InternalServerException
    
    ValidationException
    
    See Also:
    
    AWS API Documentation
  - putMetadata
```
public PutMetadataResult putMetadata(PutMetadataRequest request)
```
    Inserts metadata into the active stream of the specified channel. At most 5 requests per second per channel are allowed, each with a maximum 1 KB payload. (If 5 TPS is not sufficient for your needs, we recommend batching your data into a single PutMetadata call.) At most 155 requests per second per account are allowed. Also see Embedding Metadata within a Video Stream in the Amazon IVS User Guide.
    
    Specified by:
    
    putMetadata in interface AmazonIVS
    
    Parameters:
    
    putMetadataRequest -
    
    Returns:
    
    Result of the PutMetadata operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException
    
    AccessDeniedException
    
    ValidationException
    
    ChannelNotBroadcastingException
    
    ThrottlingException
    
    See Also:
    
    AWS API Documentation
  - stopStream
```
public StopStreamResult stopStream(StopStreamRequest request)
```
    Disconnects the incoming RTMPS stream for the specified channel. Can be used in conjunction with DeleteStreamKey to prevent further streaming to a channel.
    
    Many streaming client-software libraries automatically reconnect a dropped RTMPS session, so to stop the stream permanently, you may want to first revoke the streamKey attached to the channel.
    
    Specified by:
    
    stopStream in interface AmazonIVS
    
    Parameters:
    
    stopStreamRequest -
    
    Returns:
    
    Result of the StopStream operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException
    
    AccessDeniedException
    
    ValidationException
    
    ChannelNotBroadcastingException
    
    StreamUnavailableException
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Adds or updates tags for the Amazon Web Services resource with the specified ARN.
    
    Specified by:
    
    tagResource in interface AmazonIVS
    
    Parameters:
    
    tagResourceRequest -
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException
    
    InternalServerException
    
    ValidationException
    
    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 AmazonIVS
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException
    
    InternalServerException
    
    ValidationException
    
    See Also:
    
    AWS API Documentation
  - updateChannel
```
public UpdateChannelResult updateChannel(UpdateChannelRequest request)
```
    Updates a channel's configuration. This does not affect an ongoing stream of this channel. You must stop and restart the stream for the changes to take effect.
    
    Specified by:
    
    updateChannel in interface AmazonIVS
    
    Parameters:
    
    updateChannelRequest -
    
    Returns:
    
    Result of the UpdateChannel operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException
    
    AccessDeniedException
    
    ValidationException
    
    PendingVerificationException
    
    ConflictException
    
    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 AmazonIVS
    
    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 AmazonIVS
    
    Overrides:
    
    shutdown in class AmazonWebServiceClient

Did this page help you?

Class AmazonIVSClient

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

Fields inherited from interface com.amazonaws.services.ivs.AmazonIVS

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

Method Detail

builder

batchGetChannel

batchGetStreamKey

createChannel

createRecordingConfiguration

createStreamKey

deleteChannel

deletePlaybackKeyPair

deleteRecordingConfiguration

deleteStreamKey

getChannel

getPlaybackKeyPair

getRecordingConfiguration

getStream

getStreamKey

importPlaybackKeyPair

listChannels

listPlaybackKeyPairs

listRecordingConfigurations

listStreamKeys

listStreams

listTagsForResource

putMetadata

stopStream

tagResource

untagResource

updateChannel

getCachedResponseMetadata

shutdown