IVS

import { IVS } from "https://aws-api.deno.dev/v0.3/services/ivs.ts?docs=full";

class IVS {

constructor(apiFactory: client.ApiFactory);

async batchGetChannel(params: BatchGetChannelRequest, opts?: client.RequestOptions): Promise<BatchGetChannelResponse>;

async batchGetStreamKey(params: BatchGetStreamKeyRequest, opts?: client.RequestOptions): Promise<BatchGetStreamKeyResponse>;

async createChannel(params?: CreateChannelRequest, opts?: client.RequestOptions): Promise<CreateChannelResponse>;

async createRecordingConfiguration(params: CreateRecordingConfigurationRequest, opts?: client.RequestOptions): Promise<CreateRecordingConfigurationResponse>;

async createStreamKey(params: CreateStreamKeyRequest, opts?: client.RequestOptions): Promise<CreateStreamKeyResponse>;

async deleteChannel(params: DeleteChannelRequest, opts?: client.RequestOptions): Promise<void>;

async deletePlaybackKeyPair(params: DeletePlaybackKeyPairRequest, opts?: client.RequestOptions): Promise<void>;

async deleteRecordingConfiguration(params: DeleteRecordingConfigurationRequest, opts?: client.RequestOptions): Promise<void>;

async deleteStreamKey(params: DeleteStreamKeyRequest, opts?: client.RequestOptions): Promise<void>;

async getChannel(params: GetChannelRequest, opts?: client.RequestOptions): Promise<GetChannelResponse>;

async getPlaybackKeyPair(params: GetPlaybackKeyPairRequest, opts?: client.RequestOptions): Promise<GetPlaybackKeyPairResponse>;

async getRecordingConfiguration(params: GetRecordingConfigurationRequest, opts?: client.RequestOptions): Promise<GetRecordingConfigurationResponse>;

async getStream(params: GetStreamRequest, opts?: client.RequestOptions): Promise<GetStreamResponse>;

async getStreamKey(params: GetStreamKeyRequest, opts?: client.RequestOptions): Promise<GetStreamKeyResponse>;

async getStreamSession(params: GetStreamSessionRequest, opts?: client.RequestOptions): Promise<GetStreamSessionResponse>;

async importPlaybackKeyPair(params: ImportPlaybackKeyPairRequest, opts?: client.RequestOptions): Promise<ImportPlaybackKeyPairResponse>;

async listChannels(params?: ListChannelsRequest, opts?: client.RequestOptions): Promise<ListChannelsResponse>;

async listPlaybackKeyPairs(params?: ListPlaybackKeyPairsRequest, opts?: client.RequestOptions): Promise<ListPlaybackKeyPairsResponse>;

async listRecordingConfigurations(params?: ListRecordingConfigurationsRequest, opts?: client.RequestOptions): Promise<ListRecordingConfigurationsResponse>;

async listStreamKeys(params: ListStreamKeysRequest, opts?: client.RequestOptions): Promise<ListStreamKeysResponse>;

async listStreams(params?: ListStreamsRequest, opts?: client.RequestOptions): Promise<ListStreamsResponse>;

async listStreamSessions(params: ListStreamSessionsRequest, opts?: client.RequestOptions): Promise<ListStreamSessionsResponse>;

async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>;

async putMetadata(params: PutMetadataRequest, opts?: client.RequestOptions): Promise<void>;

async stopStream(params: StopStreamRequest, opts?: client.RequestOptions): Promise<void>;

async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async updateChannel(params: UpdateChannelRequest, opts?: client.RequestOptions): Promise<UpdateChannelResponse>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new IVS(apiFactory: client.ApiFactory)

[src]

§Methods

batchGetChannel(params: BatchGetChannelRequest, opts?: client.RequestOptions): Promise<BatchGetChannelResponse>

[src]

Performs "GetChannel" on multiple ARNs simultaneously.

batchGetStreamKey(params: BatchGetStreamKeyRequest, opts?: client.RequestOptions): Promise<BatchGetStreamKeyResponse>

[src]

Performs "GetStreamKey" on multiple ARNs simultaneously.

createChannel(params?: CreateChannelRequest, opts?: client.RequestOptions): Promise<CreateChannelResponse>

[src]

Creates a new channel and an associated stream key to start streaming.

createRecordingConfiguration(params: CreateRecordingConfigurationRequest, opts?: client.RequestOptions): Promise<CreateRecordingConfigurationResponse>

[src]

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.

createStreamKey(params: CreateStreamKeyRequest, opts?: client.RequestOptions): Promise<CreateStreamKeyResponse>

[src]

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.

deleteChannel(params: DeleteChannelRequest, opts?: client.RequestOptions): Promise<void>

[src]

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.)

deletePlaybackKeyPair(params: DeletePlaybackKeyPairRequest, opts?: client.RequestOptions): Promise<void>

[src]

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.

deleteRecordingConfiguration(params: DeleteRecordingConfigurationRequest, opts?: client.RequestOptions): Promise<void>

[src]

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.

deleteStreamKey(params: DeleteStreamKeyRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes the stream key for the specified ARN, so it can no longer be used to stream.

getChannel(params: GetChannelRequest, opts?: client.RequestOptions): Promise<GetChannelResponse>

[src]

Gets the channel configuration for the specified channel ARN. See also "BatchGetChannel".

getPlaybackKeyPair(params: GetPlaybackKeyPairRequest, opts?: client.RequestOptions): Promise<GetPlaybackKeyPairResponse>

[src]

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.

getRecordingConfiguration(params: GetRecordingConfigurationRequest, opts?: client.RequestOptions): Promise<GetRecordingConfigurationResponse>

[src]

Gets the recording configuration for the specified ARN.

getStream(params: GetStreamRequest, opts?: client.RequestOptions): Promise<GetStreamResponse>

[src]

Gets information about the active (live) stream on a specified channel.

getStreamKey(params: GetStreamKeyRequest, opts?: client.RequestOptions): Promise<GetStreamKeyResponse>

[src]

Gets stream-key information for a specified ARN.

getStreamSession(params: GetStreamSessionRequest, opts?: client.RequestOptions): Promise<GetStreamSessionResponse>

[src]

Gets metadata on a specified stream.

importPlaybackKeyPair(params: ImportPlaybackKeyPairRequest, opts?: client.RequestOptions): Promise<ImportPlaybackKeyPairResponse>

[src]

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.

listChannels(params?: ListChannelsRequest, opts?: client.RequestOptions): Promise<ListChannelsResponse>

[src]

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).

listPlaybackKeyPairs(params?: ListPlaybackKeyPairsRequest, opts?: client.RequestOptions): Promise<ListPlaybackKeyPairsResponse>

[src]

Gets summary information about playback key pairs. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.

listRecordingConfigurations(params?: ListRecordingConfigurationsRequest, opts?: client.RequestOptions): Promise<ListRecordingConfigurationsResponse>

[src]

Gets summary information about all recording configurations in your account, in the Amazon Web Services region where the API request is processed.

listStreamKeys(params: ListStreamKeysRequest, opts?: client.RequestOptions): Promise<ListStreamKeysResponse>

[src]

Gets summary information about stream keys for the specified channel.

listStreams(params?: ListStreamsRequest, opts?: client.RequestOptions): Promise<ListStreamsResponse>

[src]

Gets summary information about live streams in your account, in the Amazon Web Services region where the API request is processed.

listStreamSessions(params: ListStreamSessionsRequest, opts?: client.RequestOptions): Promise<ListStreamSessionsResponse>

[src]

Gets a summary of current and previous streams for a specified channel in your account, in the AWS region where the API request is processed.

listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>

[src]

Gets information about Amazon Web Services tags for the specified ARN.

putMetadata(params: PutMetadataRequest, opts?: client.RequestOptions): Promise<void>

[src]

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.

stopStream(params: StopStreamRequest, opts?: client.RequestOptions): Promise<void>

[src]

Disconnects the incoming RTMPS stream for the specified channel. Can be used in conjunction with "DeleteStreamKey" to prevent further streaming to a channel.

Note: 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.

tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Adds or updates tags for the Amazon Web Services resource with the specified ARN.

untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Removes tags from the resource with the specified ARN.

updateChannel(params: UpdateChannelRequest, opts?: client.RequestOptions): Promise<UpdateChannelResponse>

[src]

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.

§Static Properties

ApiMetadata: client.ApiMetadata

[src]