(constructor)

[configuration]

Constructs a new instance of the <code>IvsClient</code> class

config

The resolved configuration of IvsClient class. This is resolved and normalized from the [constructor configuration interface](@aws-sdk/client-ivs!IvsClientConfig:Interface).

destroy

Destroy underlying resources, like sockets. It's usually not necessary to do this. However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed. Otherwise, sockets might stay open for quite a long time before the server terminates them.

middlewareStack

send

command

options

IvsClient

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 <a href="https://docs.aws.amazon.com/general/latest/gr/ivs.html">Amazon IVS page</a> 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 <a href="https://docs.aws.amazon.com/ivs/latest/userguide/doc-history.html"> Document History</a>. Allowed Header Values <ul> <li> <code> Accept: </code> application/json </li> <li> <code> Accept-Encoding: </code> gzip, deflate </li> <li> <code> Content-Type: </code>application/json </li> </ul> Key Concepts <ul> <li> 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. </li> <li> Stream key — An identifier assigned by Amazon IVS when you create a channel, which is then used to authorize streaming. Treat the stream key like a secret, since it allows anyone to stream to the channel. </li> <li> 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. </li> <li> 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. </li> <li> Playback restriction policy — Restricts playback by countries and/or origin sites. </li> </ul> For more information about your IVS live stream, also see <a href="https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started.html">Getting Started with IVS Low-Latency Streaming</a>. Tagging A tag is a metadata label that you assign to an Amazon Web Services resource. A tag comprises a key and a value, 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/tag-editor/latest/userguide/best-practices-and-strats.html">Best practices and strategies</a> in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there. 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>). The Amazon IVS API has these tag-related operations: TagResource, UntagResource, and ListTagsForResource. The following resources support tagging: Channels, Stream Keys, Playback Key Pairs, and Recording Configurations. At most 50 tags can be applied to a resource. Authentication versus Authorization Note the differences between these concepts: <ul> <li> Authentication is about verifying identity. You need to be authenticated to sign Amazon IVS API requests. </li> <li> Authorization is about granting permissions. Your IAM roles need to have permissions for Amazon IVS API requests. In addition, authorization is needed 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.") </li> </ul> Authentication 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. 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 a user account that has the <code>ivs:PutMetadata</code> permission. For more information: <ul> <li> 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 Amazon Web Services General Reference. </li> <li> 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 Amazon IVS User Guide. </li> </ul> Amazon Resource Names (ARNs) ARNs uniquely identify AWS resources. An ARN is required when you need to specify a resource unambiguously across all of AWS, such as in IAM policies and API calls. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names</a> in the AWS General Reference.

defaultsMode

The [@smithy/smithy-client#DefaultsMode](@smithy/smithy-client!DefaultsMode:type) that will be used to determine how certain default configuration options are resolved in the SDK.

disableHostPrefix

Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.

extensions

logger

Optional logger for logging debug/info/warn/error.

maxAttempts

Value for how many times a request will be made at most in case of retry.

region

The AWS region to which this client will send requests

requestHandler

The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.

retryMode

useDualstackEndpoint

useFipsEndpoint

ClientDefaults

BatchGetChannelCommand

Performs GetChannel on multiple ARNs simultaneously.

BatchGetStreamKeyCommand

Performs GetStreamKey on multiple ARNs simultaneously.

BatchStartViewerSessionRevocationCommand

Performs StartViewerSessionRevocation on multiple channel ARN and viewer ID pairs simultaneously.

CreateChannelCommand

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

CreatePlaybackRestrictionPolicyCommand

Creates a new playback restriction policy, for constraining playback by countries and/or origins.

CreateRecordingConfigurationCommand

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 <code>state</code> of the recording configuration is <code>CREATE_FAILED</code> (instead of <code>ACTIVE</code>). (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.

CreateStreamKeyCommand

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.

DeleteChannelCommand

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 is no longer Live), then call DeleteChannel. (See <a href="https://docs.aws.amazon.com/ivs/latest/userguide/eventbridge.html"> Using EventBridge with Amazon IVS</a>.)

DeletePlaybackKeyPairCommand

Deletes a specified authorization key pair. This invalidates future viewer tokens generated using the key pair’s <code>privateKey</code>. For more information, see <a href="https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html">Setting Up Private Channels</a> in the Amazon IVS User Guide.

DeletePlaybackRestrictionPolicyCommand

Deletes the specified playback restriction policy.

DeleteRecordingConfigurationCommand

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 <code>recordingConfigurationArn</code> field to an empty string, then use DeleteRecordingConfiguration.

DeleteStreamKeyCommand

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

GetChannelCommand

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

GetPlaybackKeyPairCommand

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. For more information, see <a href="https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html">Setting Up Private Channels</a> in the Amazon IVS User Guide.

GetPlaybackRestrictionPolicyCommand

Gets the specified playback restriction policy.

GetRecordingConfigurationCommand

Gets the recording configuration for the specified ARN.

GetStreamCommand

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

GetStreamKeyCommand

Gets stream-key information for a specified ARN.

GetStreamSessionCommand

Gets metadata on a specified stream.

ImportPlaybackKeyPairCommand

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. For more information, see <a href="https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html">Setting Up Private Channels</a> in the Amazon IVS User Guide.

ListChannelsCommand

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

ListPlaybackKeyPairsCommand

Gets summary information about playback key pairs. For more information, see <a href="https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html">Setting Up Private Channels</a> in the Amazon IVS User Guide.

ListPlaybackRestrictionPoliciesCommand

Gets summary information about playback restriction policies.

ListRecordingConfigurationsCommand

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

ListStreamKeysCommand

Gets summary information about stream keys for the specified channel.

ListStreamSessionsCommand

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.

ListStreamsCommand

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

ListTagsForResourceCommand

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

PutMetadataCommand

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 <a href="https://docs.aws.amazon.com/ivs/latest/userguide/metadata.html">Embedding Metadata within a Video Stream</a> in the Amazon IVS User Guide.

StartViewerSessionRevocationCommand

Starts the process of revoking the viewer session associated with a specified channel ARN and viewer ID. Optionally, you can provide a version to revoke viewer sessions less than and including that version. For instructions on associating a viewer ID with a viewer session, see <a href="https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html">Setting Up Private Channels</a>.

StopStreamCommand

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 <code>streamKey</code> attached to the channel. </note>

TagResourceCommand

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

UntagResourceCommand

Removes tags from the resource with the specified ARN.

UpdateChannelCommand

Updates a channel's configuration. Live channels cannot be updated. You must stop the ongoing stream, update the channel, and restart the stream for the changes to take effect.

UpdatePlaybackRestrictionPolicyCommand

Updates a specified playback restriction policy.