-Resources +Key Concepts
-The following resources contain information about your IVS live stream (see Getting Started with -Amazon IVS):
-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.
+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.-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. -Treat the stream key like -a secret, since it allows anyone to stream to the -channel. +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.
-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.
+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.-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.
+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.-Playback restriction policy — Restricts playback by -countries and/or origin sites. See the Playback Restriction Policy endpoints for more -information.
+Playback restriction policy — Restricts playback by countries and/or origin sites.For more information about your IVS live stream, also see Getting Started with IVS Low-Latency Streaming.
Tagging
@@ -268,7 +253,7 @@ simultaneously.-RecordingConfiguration Endpoints +Recording Configuration Endpoints
-StreamKey Endpoints +Stream Key Endpoints
- * Resources + * Key Concepts *
- *The following resources contain information about your IVS live stream (see Getting Started with - * Amazon IVS):
*- * 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.
+ * 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. *- * 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. - * Treat the stream key like - * a secret, since it allows anyone to stream to the - * channel. + * 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. * *
*- * 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.
+ * 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. *- * 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.
+ * 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. *- * Playback restriction policy — Restricts playback by - * countries and/or origin sites. See the Playback Restriction Policy endpoints for more - * information.
+ * Playback restriction policy — Restricts playback by countries and/or origin sites. *For more information about your IVS live stream, also see Getting Started with IVS Low-Latency Streaming.
** Tagging *
@@ -976,7 +961,7 @@ export interface Ivs { * * *- * RecordingConfiguration Endpoints + * Recording Configuration Endpoints *
*- * StreamKey Endpoints + * Stream Key Endpoints *
*- * Resources + * Key Concepts *
- *The following resources contain information about your IVS live stream (see Getting Started with - * Amazon IVS):
*- * 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.
+ * 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. *- * 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. - * Treat the stream key like - * a secret, since it allows anyone to stream to the - * channel. + * 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. * *
*- * 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.
+ * 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. *- * 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.
+ * 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. *- * Playback restriction policy — Restricts playback by - * countries and/or origin sites. See the Playback Restriction Policy endpoints for more - * information.
+ * Playback restriction policy — Restricts playback by countries and/or origin sites. *For more information about your IVS live stream, also see Getting Started with IVS Low-Latency Streaming.
** Tagging *
@@ -658,7 +643,7 @@ export interface IvsClientResolvedConfig extends IvsClientResolvedConfigType {} * * *- * RecordingConfiguration Endpoints + * Recording Configuration Endpoints *
*- * StreamKey Endpoints + * Stream Key Endpoints *
*- * Resources + * Key Concepts *
- *The following resources contain information about your IVS live stream (see Getting Started with - * Amazon IVS):
*- * 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.
+ * 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. *- * 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. - * Treat the stream key like - * a secret, since it allows anyone to stream to the - * channel. + * 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. * *
*- * 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.
+ * 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. *- * 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.
+ * 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. *- * Playback restriction policy — Restricts playback by - * countries and/or origin sites. See the Playback Restriction Policy endpoints for more - * information.
+ * Playback restriction policy — Restricts playback by countries and/or origin sites. *For more information about your IVS live stream, also see Getting Started with IVS Low-Latency Streaming.
** Tagging *
@@ -263,7 +248,7 @@ * * *- * RecordingConfiguration Endpoints + * Recording Configuration Endpoints *
*- * StreamKey Endpoints + * Stream Key Endpoints *
*Specifies information needed to stream using the SRT protocol.
+ * @public + */ +export interface Srt { + /** + *The endpoint to be used when streaming with IVS using the SRT protocol.
+ * @public + */ + endpoint?: string; + + /** + *Auto-generated passphrase to enable encryption. This field is applicable only if the end
+ * user has not enabled the insecureIngest option for the
+ * channel.
Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. - * Default: "" (empty string, recording is disabled).
+ *Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables + * recording. Default: "" (empty string, recording is disabled).
* @public */ recordingConfigurationArn?: string; @@ -171,7 +191,15 @@ export interface Channel { preset?: TranscodePreset; /** - *Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. Default: "" (empty string, no playback restriction policy is applied).
+ *Specifies the endpoint and optional passphrase for streaming with the SRT protocol.
+ * @public + */ + srt?: Srt; + + /** + *Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables + * playback restriction. Default: "" (empty string, no playback restriction policy is + * applied).
* @public */ playbackRestrictionPolicyArn?: string; @@ -487,7 +515,7 @@ export interface CreateChannelRequest { tags?: RecordWhether the channel allows insecure RTMP ingest. Default: false.
Whether the channel allows insecure RTMP and SRT ingest. Default: false.
A list of country codes that control geoblocking restriction. Allowed values are the - * officially assigned ISO 3166-1 alpha-2 codes. Default: All countries (an empty array).
+ * officially assigned ISO 3166-1 + * alpha-2 codes. Default: All countries (an empty array). * @public */ allowedCountries: string[] | undefined; /** *A list of origin sites that control CORS restriction. Allowed values are the same as valid - * values of the Origin header defined at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin. Default: All origins (an empty array).
+ * values of the Origin header defined at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin. Default: All + * origins (an empty array). * @public */ allowedOrigins: string[] | undefined; @@ -1735,8 +1765,8 @@ export interface ChannelSummary { authorized?: boolean; /** - *Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. - * Default: "" (empty string, recording is disabled).
+ *Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables + * recording. Default: "" (empty string, recording is disabled).
* @public */ recordingConfigurationArn?: string; @@ -1776,8 +1806,9 @@ export interface ChannelSummary { preset?: TranscodePreset; /** - *Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. - * Default: "" (empty string, no playback restriction policy is applied).
+ *Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables + * playback restriction. Default: "" (empty string, no playback restriction policy is + * applied).
* @public */ playbackRestrictionPolicyArn?: string; @@ -1904,7 +1935,8 @@ export interface PlaybackRestrictionPolicySummary { /** *A list of origin sites that control CORS restriction. Allowed values are the same as valid - * values of the Origin header defined at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin. Default: All origins (an empty array).
+ * values of the Origin header defined at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin. Default: All + * origins (an empty array). * @public */ allowedOrigins: string[] | undefined; @@ -2482,7 +2514,7 @@ export interface UpdateChannelRequest { recordingConfigurationArn?: string; /** - *Whether the channel allows insecure RTMP ingest. Default: false.
Whether the channel allows insecure RTMP and SRT ingest. Default: false.
\n Introduction\n
\nThe Amazon Interactive Video Service (IVS) API is REST compatible, using a standard HTTP\n API and an Amazon Web Services EventBridge event stream for responses. JSON is used for both\n requests and responses, including errors.
\nThe API is an Amazon Web Services regional service. For a list of supported regions and\n Amazon IVS HTTPS service endpoints, see the Amazon IVS page in the\n Amazon Web Services General Reference.
\n\n \n All API request parameters and URLs are case sensitive.\n \n \n
\nFor a summary of notable documentation changes in each release, see Document\n History.
\n\n Allowed Header Values\n
\n\n \n Accept:\n application/json
\n \n Accept-Encoding:\n gzip, deflate
\n \n Content-Type:\n application/json
\n Resources\n
\nThe following resources contain information about your IVS live stream (see Getting Started with\n Amazon IVS):
\n\n Channel — Stores configuration data related to your\n live stream. You first create a channel and then use the channel’s stream key to start\n your live stream. See the Channel endpoints for more information.
\n\n Stream key — An identifier assigned by Amazon IVS\n when you create a channel, which is then used to authorize streaming. See the StreamKey\n endpoints for more information. \n Treat the stream key like\n a secret, since it allows anyone to stream to the\n channel.\n \n
\n\n Playback key pair — Video playback may be restricted\n using playback-authorization tokens, which use public-key encryption. A playback key pair\n is the public-private pair of keys used to sign and validate the playback-authorization\n token. See the PlaybackKeyPair endpoints for more information.
\n\n Recording configuration — Stores configuration\n related to recording a live stream and where to store the recorded content. Multiple\n channels can reference the same recording configuration. See the Recording Configuration\n endpoints for more information.
\n\n Playback restriction policy — Restricts playback by\n countries and/or origin sites. See the Playback Restriction Policy endpoints for more\n information.
\n\n Tagging\n
\nA tag is a metadata label that you assign to an Amazon Web Services\n resource. A tag comprises a key and a value, both\n set by you. For example, you might set a tag as topic:nature to label a\n particular video category. See Tagging Amazon Web Services Resources for\n more information, including restrictions that apply to tags and \"Tag naming limits and\n requirements\"; Amazon IVS has no service-specific constraints beyond what is documented\n there.
Tags can help you identify and organize your Amazon Web Services resources. For example,\n you can use the same tag for different resources to indicate that they are related. You can\n also use tags to manage access (see Access Tags).
\nThe Amazon IVS API has these tag-related endpoints: TagResource, UntagResource, and ListTagsForResource. The following\n resources support tagging: Channels, Stream Keys, Playback Key Pairs, and Recording\n Configurations.
\nAt most 50 tags can be applied to a resource.
\n\n Authentication versus Authorization\n
\nNote the differences between these concepts:
\n\n Authentication is about verifying identity. You need to be\n authenticated to sign Amazon IVS API requests.
\n\n Authorization is about granting permissions. Your IAM roles need to have permissions for Amazon IVS API requests. In addition,\n authorization is needed to view Amazon IVS private channels.\n (Private channels are channels that are enabled for \"playback authorization.\")
\n\n Authentication\n
\nAll Amazon IVS API requests must be authenticated with a signature. The Amazon Web Services\n Command-Line Interface (CLI) and Amazon IVS Player SDKs take care of signing the underlying\n API calls for you. However, if your application calls the Amazon IVS API directly, it’s your\n responsibility to sign the requests.
\nYou generate a signature using valid Amazon Web Services credentials that have permission\n to perform the requested action. For example, you must sign PutMetadata requests with a\n signature generated from a user account that has the ivs:PutMetadata\n permission.
For more information:
\nAuthentication and generating signatures — See Authenticating Requests\n (Amazon Web Services Signature Version 4) in the Amazon Web Services\n General Reference.
\nManaging Amazon IVS permissions — See Identity and Access Management on\n the Security page of the Amazon IVS User Guide.
\n\n Amazon Resource Names (ARNs)\n
\nARNs uniquely identify AWS resources. An ARN is required when you need to specify a\n resource unambiguously across all of AWS, such as in IAM policies and API\n calls. For more information, see Amazon\n Resource Names in the AWS General Reference.
\n\n Channel Endpoints\n
\n\n CreateChannel — Creates a new channel and an associated stream\n key to start streaming.
\n\n GetChannel — Gets the channel configuration for the specified\n channel ARN.
\n\n BatchGetChannel — Performs GetChannel on\n multiple ARNs simultaneously.
\n\n ListChannels — Gets summary information about all channels in\n your account, in the Amazon Web Services region where the API request is processed. This\n list can be filtered to match a specified name or recording-configuration ARN. Filters are\n mutually exclusive and cannot be used together. If you try to use both filters, you will\n get an error (409 Conflict Exception).
\n\n UpdateChannel — Updates a channel's configuration. This does\n not affect an ongoing stream of this channel. You must stop and restart the stream for the\n changes to take effect.
\n\n DeleteChannel — Deletes the specified channel.
\n\n Playback Restriction Policy Endpoints\n
\n\n CreatePlaybackRestrictionPolicy — Creates a new playback\n restriction policy, for constraining playback by countries and/or origins.
\n\n DeletePlaybackRestrictionPolicy — Deletes the specified\n playback restriction policy
\n\n GetPlaybackRestrictionPolicy — Gets the specified playback\n restriction policy.
\n\n ListPlaybackRestrictionPolicies — Gets summary information\n about playback restriction policies.
\n\n UpdatePlaybackRestrictionPolicy — Updates a specified playback\n restriction policy.
\n\n Private Channel Endpoints\n
\nFor more information, see Setting Up Private Channels in the\n Amazon IVS User Guide.
\n\n ImportPlaybackKeyPair — Imports the public portion of a new\n key pair and returns its arn and fingerprint. The\n privateKey can then be used to generate viewer authorization tokens, to\n grant viewers access to private channels (channels enabled for playback\n authorization).
\n GetPlaybackKeyPair — Gets a specified playback authorization\n key pair and returns the arn and fingerprint. The\n privateKey held by the caller can be used to generate viewer authorization\n tokens, to grant viewers access to private channels.
\n ListPlaybackKeyPairs — Gets summary information about playback\n key pairs.
\n\n DeletePlaybackKeyPair — Deletes a specified authorization key\n pair. This invalidates future viewer tokens generated using the key pair’s\n privateKey.
\n StartViewerSessionRevocation — Starts the process of revoking\n the viewer session associated with a specified channel ARN and viewer ID. Optionally, you\n can provide a version to revoke viewer sessions less than and including that\n version.
\n\n BatchStartViewerSessionRevocation — Performs StartViewerSessionRevocation on multiple channel ARN and viewer ID pairs\n simultaneously.
\n\n RecordingConfiguration Endpoints\n
\n\n CreateRecordingConfiguration — Creates a new recording\n configuration, used to enable recording to Amazon S3.
\n\n GetRecordingConfiguration — Gets the recording-configuration\n metadata for the specified ARN.
\n\n ListRecordingConfigurations — Gets summary information about\n all recording configurations in your account, in the Amazon Web Services region where the\n API request is processed.
\n\n DeleteRecordingConfiguration — Deletes the recording\n configuration for the specified ARN.
\n\n Stream Endpoints\n
\n\n GetStream — Gets information about the active (live) stream on\n a specified channel.
\n\n GetStreamSession — Gets metadata on a specified stream.
\n\n ListStreams — Gets summary information about live streams in\n your account, in the Amazon Web Services region where the API request is processed.
\n\n ListStreamSessions — Gets a summary of current and previous\n streams for a specified channel in your account, in the AWS region where the API request\n is processed.
\n\n StopStream — Disconnects the incoming RTMPS stream for the\n specified channel. Can be used in conjunction with DeleteStreamKey to\n prevent further streaming to a channel.
\n\n PutMetadata — Inserts metadata into the active stream of the\n specified channel. At most 5 requests per second per channel are allowed, each with a\n maximum 1 KB payload. (If 5 TPS is not sufficient for your needs, we recommend batching\n your data into a single PutMetadata call.) At most 155 requests per second per account are\n allowed.
\n\n StreamKey Endpoints\n
\n\n CreateStreamKey — Creates a stream key, used to initiate a\n stream, for the specified channel ARN.
\n\n GetStreamKey — Gets stream key information for the specified\n ARN.
\n\n BatchGetStreamKey — Performs GetStreamKey on\n multiple ARNs simultaneously.
\n\n ListStreamKeys — Gets summary information about stream keys\n for the specified channel.
\n\n DeleteStreamKey — Deletes the stream key for the specified\n ARN, so it can no longer be used to stream.
\n\n Amazon Web Services Tags Endpoints\n
\n\n TagResource — Adds or updates tags for the Amazon Web Services\n resource with the specified ARN.
\n\n UntagResource — Removes tags from the resource with the\n specified ARN.
\n\n ListTagsForResource — Gets information about Amazon Web Services tags for the specified ARN.
\n\n Introduction\n
\nThe Amazon Interactive Video Service (IVS) API is REST compatible, using a standard HTTP\n API and an Amazon Web Services EventBridge event stream for responses. JSON is used for both\n requests and responses, including errors.
\nThe API is an Amazon Web Services regional service. For a list of supported regions and\n Amazon IVS HTTPS service endpoints, see the Amazon IVS page in the\n Amazon Web Services General Reference.
\n\n \n All API request parameters and URLs are case sensitive.\n \n \n
\nFor a summary of notable documentation changes in each release, see Document\n History.
\n\n Allowed Header Values\n
\n\n \n Accept:\n application/json
\n \n Accept-Encoding:\n gzip, deflate
\n \n Content-Type:\n application/json
\n Key Concepts\n
\n\n 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.
\n\n Stream key — An identifier assigned by Amazon IVS when you create a channel, which is then used to authorize streaming. \n Treat the stream key like a secret, since it allows anyone to stream to the channel.\n \n
\n\n 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.
\n\n 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.
\n\n Playback restriction policy — Restricts playback by countries and/or origin sites.
\nFor more information about your IVS live stream, also see Getting Started with IVS Low-Latency Streaming.
\n\n Tagging\n
\nA tag is a metadata label that you assign to an Amazon Web Services\n resource. A tag comprises a key and a value, both\n set by you. For example, you might set a tag as topic:nature to label a\n particular video category. See Tagging Amazon Web Services Resources for\n more information, including restrictions that apply to tags and \"Tag naming limits and\n requirements\"; Amazon IVS has no service-specific constraints beyond what is documented\n there.
Tags can help you identify and organize your Amazon Web Services resources. For example,\n you can use the same tag for different resources to indicate that they are related. You can\n also use tags to manage access (see Access Tags).
\nThe Amazon IVS API has these tag-related endpoints: TagResource, UntagResource, and ListTagsForResource. The following\n resources support tagging: Channels, Stream Keys, Playback Key Pairs, and Recording\n Configurations.
\nAt most 50 tags can be applied to a resource.
\n\n Authentication versus Authorization\n
\nNote the differences between these concepts:
\n\n Authentication is about verifying identity. You need to be\n authenticated to sign Amazon IVS API requests.
\n\n Authorization is about granting permissions. Your IAM roles need to have permissions for Amazon IVS API requests. In addition,\n authorization is needed to view Amazon IVS private channels.\n (Private channels are channels that are enabled for \"playback authorization.\")
\n\n Authentication\n
\nAll Amazon IVS API requests must be authenticated with a signature. The Amazon Web Services\n Command-Line Interface (CLI) and Amazon IVS Player SDKs take care of signing the underlying\n API calls for you. However, if your application calls the Amazon IVS API directly, it’s your\n responsibility to sign the requests.
\nYou generate a signature using valid Amazon Web Services credentials that have permission\n to perform the requested action. For example, you must sign PutMetadata requests with a\n signature generated from a user account that has the ivs:PutMetadata\n permission.
For more information:
\nAuthentication and generating signatures — See Authenticating Requests\n (Amazon Web Services Signature Version 4) in the Amazon Web Services\n General Reference.
\nManaging Amazon IVS permissions — See Identity and Access Management on\n the Security page of the Amazon IVS User Guide.
\n\n Amazon Resource Names (ARNs)\n
\nARNs uniquely identify AWS resources. An ARN is required when you need to specify a\n resource unambiguously across all of AWS, such as in IAM policies and API\n calls. For more information, see Amazon\n Resource Names in the AWS General Reference.
\n\n Channel Endpoints\n
\n\n CreateChannel — Creates a new channel and an associated stream\n key to start streaming.
\n\n GetChannel — Gets the channel configuration for the specified\n channel ARN.
\n\n BatchGetChannel — Performs GetChannel on\n multiple ARNs simultaneously.
\n\n ListChannels — Gets summary information about all channels in\n your account, in the Amazon Web Services region where the API request is processed. This\n list can be filtered to match a specified name or recording-configuration ARN. Filters are\n mutually exclusive and cannot be used together. If you try to use both filters, you will\n get an error (409 Conflict Exception).
\n\n UpdateChannel — Updates a channel's configuration. This does\n not affect an ongoing stream of this channel. You must stop and restart the stream for the\n changes to take effect.
\n\n DeleteChannel — Deletes the specified channel.
\n\n Playback Restriction Policy Endpoints\n
\n\n CreatePlaybackRestrictionPolicy — Creates a new playback\n restriction policy, for constraining playback by countries and/or origins.
\n\n DeletePlaybackRestrictionPolicy — Deletes the specified\n playback restriction policy
\n\n GetPlaybackRestrictionPolicy — Gets the specified playback\n restriction policy.
\n\n ListPlaybackRestrictionPolicies — Gets summary information\n about playback restriction policies.
\n\n UpdatePlaybackRestrictionPolicy — Updates a specified playback\n restriction policy.
\n\n Private Channel Endpoints\n
\nFor more information, see Setting Up Private Channels in the\n Amazon IVS User Guide.
\n\n ImportPlaybackKeyPair — Imports the public portion of a new\n key pair and returns its arn and fingerprint. The\n privateKey can then be used to generate viewer authorization tokens, to\n grant viewers access to private channels (channels enabled for playback\n authorization).
\n GetPlaybackKeyPair — Gets a specified playback authorization\n key pair and returns the arn and fingerprint. The\n privateKey held by the caller can be used to generate viewer authorization\n tokens, to grant viewers access to private channels.
\n ListPlaybackKeyPairs — Gets summary information about playback\n key pairs.
\n\n DeletePlaybackKeyPair — Deletes a specified authorization key\n pair. This invalidates future viewer tokens generated using the key pair’s\n privateKey.
\n StartViewerSessionRevocation — Starts the process of revoking\n the viewer session associated with a specified channel ARN and viewer ID. Optionally, you\n can provide a version to revoke viewer sessions less than and including that\n version.
\n\n BatchStartViewerSessionRevocation — Performs StartViewerSessionRevocation on multiple channel ARN and viewer ID pairs\n simultaneously.
\n\n Recording Configuration Endpoints\n
\n\n CreateRecordingConfiguration — Creates a new recording\n configuration, used to enable recording to Amazon S3.
\n\n GetRecordingConfiguration — Gets the recording-configuration\n metadata for the specified ARN.
\n\n ListRecordingConfigurations — Gets summary information about\n all recording configurations in your account, in the Amazon Web Services region where the\n API request is processed.
\n\n DeleteRecordingConfiguration — Deletes the recording\n configuration for the specified ARN.
\n\n Stream Endpoints\n
\n\n GetStream — Gets information about the active (live) stream on\n a specified channel.
\n\n GetStreamSession — Gets metadata on a specified stream.
\n\n ListStreams — Gets summary information about live streams in\n your account, in the Amazon Web Services region where the API request is processed.
\n\n ListStreamSessions — Gets a summary of current and previous\n streams for a specified channel in your account, in the AWS region where the API request\n is processed.
\n\n StopStream — Disconnects the incoming RTMPS stream for the\n specified channel. Can be used in conjunction with DeleteStreamKey to\n prevent further streaming to a channel.
\n\n PutMetadata — Inserts metadata into the active stream of the\n specified channel. At most 5 requests per second per channel are allowed, each with a\n maximum 1 KB payload. (If 5 TPS is not sufficient for your needs, we recommend batching\n your data into a single PutMetadata call.) At most 155 requests per second per account are\n allowed.
\n\n Stream Key Endpoints\n
\n\n CreateStreamKey — Creates a stream key, used to initiate a\n stream, for the specified channel ARN.
\n\n GetStreamKey — Gets stream key information for the specified\n ARN.
\n\n BatchGetStreamKey — Performs GetStreamKey on\n multiple ARNs simultaneously.
\n\n ListStreamKeys — Gets summary information about stream keys\n for the specified channel.
\n\n DeleteStreamKey — Deletes the stream key for the specified\n ARN, so it can no longer be used to stream.
\n\n Amazon Web Services Tags Endpoints\n
\n\n TagResource — Adds or updates tags for the Amazon Web Services\n resource with the specified ARN.
\n\n UntagResource — Removes tags from the resource with the\n specified ARN.
\n\n ListTagsForResource — Gets information about Amazon Web Services tags for the specified ARN.
\nRecording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording.\n Default: \"\" (empty string, recording is disabled).
" + "smithy.api#documentation": "Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables\n recording. Default: \"\" (empty string, recording is disabled).
" } }, "ingestEndpoint": { @@ -1238,10 +1238,16 @@ "smithy.api#documentation": "Optional transcode preset for the channel. This is selectable only for\n ADVANCED_HD and ADVANCED_SD channel types. For those channel\n types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other\n channel types (BASIC and STANDARD), preset is the empty\n string (\"\").
Specifies the endpoint and optional passphrase for streaming with the SRT protocol.
" + } + }, "playbackRestrictionPolicyArn": { "target": "com.amazonaws.ivs#ChannelPlaybackRestrictionPolicyArn", "traits": { - "smithy.api#documentation": "Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. Default: \"\" (empty string, no playback restriction policy is applied).
" + "smithy.api#documentation": "Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables\n playback restriction. Default: \"\" (empty string, no playback restriction policy is\n applied).
" } } }, @@ -1369,7 +1375,7 @@ "recordingConfigurationArn": { "target": "com.amazonaws.ivs#ChannelRecordingConfigurationArn", "traits": { - "smithy.api#documentation": "Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording.\n Default: \"\" (empty string, recording is disabled).
" + "smithy.api#documentation": "Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables\n recording. Default: \"\" (empty string, recording is disabled).
" } }, "tags": { @@ -1400,7 +1406,7 @@ "playbackRestrictionPolicyArn": { "target": "com.amazonaws.ivs#ChannelPlaybackRestrictionPolicyArn", "traits": { - "smithy.api#documentation": "Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction.\n Default: \"\" (empty string, no playback restriction policy is applied).
" + "smithy.api#documentation": "Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables\n playback restriction. Default: \"\" (empty string, no playback restriction policy is\n applied).
" } } }, @@ -1536,7 +1542,7 @@ "target": "com.amazonaws.ivs#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Whether the channel allows insecure RTMP ingest. Default: false.
Whether the channel allows insecure RTMP and SRT ingest. Default: false.
A list of country codes that control geoblocking restriction. Allowed values are the\n officially assigned ISO 3166-1 alpha-2 codes. Default: All countries (an empty array).
", + "smithy.api#documentation": "A list of country codes that control geoblocking restriction. Allowed values are the\n officially assigned ISO 3166-1\n alpha-2 codes. Default: All countries (an empty array).
", "smithy.api#required": {} } }, "allowedOrigins": { "target": "com.amazonaws.ivs#PlaybackRestrictionPolicyAllowedOriginList", "traits": { - "smithy.api#documentation": "A list of origin sites that control CORS restriction. Allowed values are the same as valid\n values of the Origin header defined at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin. Default: All origins (an empty array).
", + "smithy.api#documentation": "A list of origin sites that control CORS restriction. Allowed values are the same as valid\n values of the Origin header defined at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin. Default: All\n origins (an empty array).
", "smithy.api#required": {} } }, @@ -3420,7 +3426,7 @@ "allowedOrigins": { "target": "com.amazonaws.ivs#PlaybackRestrictionPolicyAllowedOriginList", "traits": { - "smithy.api#documentation": "A list of origin sites that control CORS restriction. Allowed values are the same as valid\n values of the Origin header defined at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin. Default: All origins (an empty array).
", + "smithy.api#documentation": "A list of origin sites that control CORS restriction. Allowed values are the same as valid\n values of the Origin header defined at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin. Default: All\n origins (an empty array).
", "smithy.api#required": {} } }, @@ -3809,6 +3815,35 @@ "smithy.api#httpError": 402 } }, + "com.amazonaws.ivs#Srt": { + "type": "structure", + "members": { + "endpoint": { + "target": "com.amazonaws.ivs#SrtEndpoint", + "traits": { + "smithy.api#documentation": "The endpoint to be used when streaming with IVS using the SRT protocol.
" + } + }, + "passphrase": { + "target": "com.amazonaws.ivs#SrtPassphrase", + "traits": { + "smithy.api#documentation": "Auto-generated passphrase to enable encryption. This field is applicable only if the end\n user has not enabled the insecureIngest option for the\n channel.
Specifies information needed to stream using the SRT protocol.
" + } + }, + "com.amazonaws.ivs#SrtEndpoint": { + "type": "string" + }, + "com.amazonaws.ivs#SrtPassphrase": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, "com.amazonaws.ivs#StartViewerSessionRevocation": { "type": "operation", "input": { @@ -4699,7 +4734,7 @@ "target": "com.amazonaws.ivs#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Whether the channel allows insecure RTMP ingest. Default: false.
Whether the channel allows insecure RTMP and SRT ingest. Default: false.