diff --git a/clients/client-ivs/src/commands/BatchStartViewerSessionRevocationCommand.ts b/clients/client-ivs/src/commands/BatchStartViewerSessionRevocationCommand.ts index adfc9457561f7..57b164b257b6b 100644 --- a/clients/client-ivs/src/commands/BatchStartViewerSessionRevocationCommand.ts +++ b/clients/client-ivs/src/commands/BatchStartViewerSessionRevocationCommand.ts @@ -82,6 +82,15 @@ export interface BatchStartViewerSessionRevocationCommandOutput * @see {@link BatchStartViewerSessionRevocationCommandOutput} for command's `response` shape. * @see {@link IvsClientResolvedConfig | config} for IvsClient's `config` shape. * + * @throws {@link AccessDeniedException} (client fault) + *
+ * + * @throws {@link PendingVerification} (client fault) + * + * + * @throws {@link ThrottlingException} (client fault) + * + * * @throws {@link ValidationException} (client fault) * * diff --git a/clients/client-ivs/src/commands/CreateRecordingConfigurationCommand.ts b/clients/client-ivs/src/commands/CreateRecordingConfigurationCommand.ts index f52bafb42ac5d..a2f0a7385fa9c 100644 --- a/clients/client-ivs/src/commands/CreateRecordingConfigurationCommand.ts +++ b/clients/client-ivs/src/commands/CreateRecordingConfigurationCommand.ts @@ -72,8 +72,18 @@ export interface CreateRecordingConfigurationCommandOutput * thumbnailConfiguration: { // ThumbnailConfiguration * recordingMode: "STRING_VALUE", * targetIntervalSeconds: Number("long"), + * resolution: "STRING_VALUE", + * storage: [ // ThumbnailConfigurationStorageList + * "STRING_VALUE", + * ], * }, * recordingReconnectWindowSeconds: Number("int"), + * renditionConfiguration: { // RenditionConfiguration + * renditionSelection: "STRING_VALUE", + * renditions: [ // RenditionConfigurationRenditionList + * "STRING_VALUE", + * ], + * }, * }; * const command = new CreateRecordingConfigurationCommand(input); * const response = await client.send(command); @@ -93,8 +103,18 @@ export interface CreateRecordingConfigurationCommandOutput * // thumbnailConfiguration: { // ThumbnailConfiguration * // recordingMode: "STRING_VALUE", * // targetIntervalSeconds: Number("long"), + * // resolution: "STRING_VALUE", + * // storage: [ // ThumbnailConfigurationStorageList + * // "STRING_VALUE", + * // ], * // }, * // recordingReconnectWindowSeconds: Number("int"), + * // renditionConfiguration: { // RenditionConfiguration + * // renditionSelection: "STRING_VALUE", + * // renditions: [ // RenditionConfigurationRenditionList + * // "STRING_VALUE", + * // ], + * // }, * // }, * // }; * diff --git a/clients/client-ivs/src/commands/GetRecordingConfigurationCommand.ts b/clients/client-ivs/src/commands/GetRecordingConfigurationCommand.ts index aa6a8402bb6be..c141b2b720573 100644 --- a/clients/client-ivs/src/commands/GetRecordingConfigurationCommand.ts +++ b/clients/client-ivs/src/commands/GetRecordingConfigurationCommand.ts @@ -64,8 +64,18 @@ export interface GetRecordingConfigurationCommandOutput extends GetRecordingConf * // thumbnailConfiguration: { // ThumbnailConfiguration * // recordingMode: "STRING_VALUE", * // targetIntervalSeconds: Number("long"), + * // resolution: "STRING_VALUE", + * // storage: [ // ThumbnailConfigurationStorageList + * // "STRING_VALUE", + * // ], * // }, * // recordingReconnectWindowSeconds: Number("int"), + * // renditionConfiguration: { // RenditionConfiguration + * // renditionSelection: "STRING_VALUE", + * // renditions: [ // RenditionConfigurationRenditionList + * // "STRING_VALUE", + * // ], + * // }, * // }, * // }; * diff --git a/clients/client-ivs/src/commands/GetStreamSessionCommand.ts b/clients/client-ivs/src/commands/GetStreamSessionCommand.ts index c87d12660d051..fb068bc1dc416 100644 --- a/clients/client-ivs/src/commands/GetStreamSessionCommand.ts +++ b/clients/client-ivs/src/commands/GetStreamSessionCommand.ts @@ -102,8 +102,18 @@ export interface GetStreamSessionCommandOutput extends GetStreamSessionResponse, * // thumbnailConfiguration: { // ThumbnailConfiguration * // recordingMode: "STRING_VALUE", * // targetIntervalSeconds: Number("long"), + * // resolution: "STRING_VALUE", + * // storage: [ // ThumbnailConfigurationStorageList + * // "STRING_VALUE", + * // ], * // }, * // recordingReconnectWindowSeconds: Number("int"), + * // renditionConfiguration: { // RenditionConfiguration + * // renditionSelection: "STRING_VALUE", + * // renditions: [ // RenditionConfigurationRenditionList + * // "STRING_VALUE", + * // ], + * // }, * // }, * // truncatedEvents: [ // StreamEvents * // { // StreamEvent diff --git a/clients/client-ivs/src/commands/StartViewerSessionRevocationCommand.ts b/clients/client-ivs/src/commands/StartViewerSessionRevocationCommand.ts index 3af88efec4d88..7cfb1433b5d67 100644 --- a/clients/client-ivs/src/commands/StartViewerSessionRevocationCommand.ts +++ b/clients/client-ivs/src/commands/StartViewerSessionRevocationCommand.ts @@ -75,6 +75,12 @@ export interface StartViewerSessionRevocationCommandOutput * @throws {@link InternalServerException} (server fault) * * + * @throws {@link PendingVerification} (client fault) + * + * + * @throws {@link ResourceNotFoundException} (client fault) + * + * * @throws {@link ThrottlingException} (client fault) * * diff --git a/clients/client-ivs/src/models/models_0.ts b/clients/client-ivs/src/models/models_0.ts index f7e588287fe81..f33e65a8a81e6 100644 --- a/clients/client-ivs/src/models/models_0.ts +++ b/clients/client-ivs/src/models/models_0.ts @@ -376,6 +376,56 @@ export interface BatchStartViewerSessionRevocationResponse { errors?: BatchStartViewerSessionRevocationError[]; } +/** + * @public + * + */ +export class PendingVerification extends __BaseException { + readonly name: "PendingVerification" = "PendingVerification"; + readonly $fault: "client" = "client"; + /** + *Your account is pending verification.
+ */ + exceptionMessage?: string; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeRequest was denied due to request throttling.
+ */ + exceptionMessage?: string; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeYour account is pending verification.
- */ - exceptionMessage?: string; - /** - * @internal - */ - constructor(opts: __ExceptionOptionTypeObject that describes which renditions should be recorded for a stream.
+ */ +export interface RenditionConfiguration { + /** + *Indicates which set of renditions are recorded for a stream. For BASIC
+ * channels, the CUSTOM
value has no effect. If CUSTOM
is specified, a
+ * set of renditions must be specified in the renditions
field. Default:
+ * ALL
.
Indicates which renditions are recorded for a stream, if renditionSelection
+ * is CUSTOM
; otherwise, this field is irrelevant. The selected renditions are
+ * recorded if they are available during the stream. If a selected rendition is unavailable, the
+ * best available rendition is recorded. For details on the resolution dimensions of each
+ * rendition, see Auto-Record to Amazon S3.
An object representing a configuration of thumbnails for recorded video.
@@ -683,15 +796,33 @@ export interface ThumbnailConfiguration { *The targeted thumbnail-generation interval in seconds. This is configurable (and required)
* only if recordingMode
is INTERVAL
. Default: 60.
- * Important: Setting a value for
- * targetIntervalSeconds
does not guarantee that thumbnails are generated at the
- * specified interval. For thumbnails to be generated at the targetIntervalSeconds
- * interval, the IDR/Keyframe
value for the input video must be less than the
- * targetIntervalSeconds
value. See Amazon IVS Streaming Configuration
- * for information on setting IDR/Keyframe
to the recommended value in video-encoder
- * settings.
BASIC
channel type,
+ * setting a value for targetIntervalSeconds
does not guarantee that thumbnails are
+ * generated at the specified interval. For thumbnails to be generated at the
+ * targetIntervalSeconds
interval, the IDR/Keyframe
value for the
+ * input video must be less than the targetIntervalSeconds
value. See Amazon IVS Streaming
+ * Configuration for information on setting IDR/Keyframe
to the
+ * recommended value in video-encoder settings.
*/
targetIntervalSeconds?: number;
+
+ /**
+ * Indicates the desired resolution of recorded thumbnails. Thumbnails are recorded at the + * selected resolution if the corresponding rendition is available during the stream; otherwise, + * they are recorded at source resolution. For more information about resolution values and their + * corresponding height and width dimensions, see Auto-Record to Amazon S3. Default: + * Null (source resolution is returned).
+ */ + resolution?: ThumbnailConfigurationResolution | string; + + /** + *Indicates the format in which thumbnails are recorded. SEQUENTIAL
records all
+ * generated thumbnails in a serial manner, to the media/thumbnails directory.
+ * LATEST
saves the latest thumbnail in media/latest_thumbnail/thumb.jpg and
+ * overwrites it at the interval specified by targetIntervalSeconds
. You can enable
+ * both SEQUENTIAL
and LATEST
. Default: SEQUENTIAL
.
Object that describes which renditions should be recorded for a stream.
+ */ + renditionConfiguration?: RenditionConfiguration; } /** @@ -791,6 +927,11 @@ export interface RecordingConfiguration { * streams will be considered a single broadcast and merged together. Default: 0. */ recordingReconnectWindowSeconds?: number; + + /** + *Object that describes which renditions should be recorded for a stream.
+ */ + renditionConfiguration?: RenditionConfiguration; } /** @@ -1898,31 +2039,6 @@ export interface PutMetadataRequest { metadata: string | undefined; } -/** - * @public - * - */ -export class ThrottlingException extends __BaseException { - readonly name: "ThrottlingException" = "ThrottlingException"; - readonly $fault: "client" = "client"; - /** - *Request was denied due to request throttling.
- */ - exceptionMessage?: string; - /** - * @internal - */ - constructor(opts: __ExceptionOptionTypeIf a broadcast disconnects and then reconnects within the specified interval, the multiple\n streams will be considered a single broadcast and merged together. Default: 0.
" } + }, + "renditionConfiguration": { + "target": "com.amazonaws.ivs#RenditionConfiguration", + "traits": { + "smithy.api#documentation": "Object that describes which renditions should be recorded for a stream.
" + } } } }, @@ -3101,6 +3116,12 @@ "smithy.api#default": 0, "smithy.api#documentation": "If a broadcast disconnects and then reconnects within the specified interval, the multiple\n streams will be considered a single broadcast and merged together. Default: 0.
" } + }, + "renditionConfiguration": { + "target": "com.amazonaws.ivs#RenditionConfiguration", + "traits": { + "smithy.api#documentation": "Object that describes which renditions should be recorded for a stream.
" + } } }, "traits": { @@ -3218,6 +3239,74 @@ } } }, + "com.amazonaws.ivs#RenditionConfiguration": { + "type": "structure", + "members": { + "renditionSelection": { + "target": "com.amazonaws.ivs#RenditionConfigurationRenditionSelection", + "traits": { + "smithy.api#documentation": "Indicates which set of renditions are recorded for a stream. For BASIC
\n channels, the CUSTOM
value has no effect. If CUSTOM
is specified, a\n set of renditions must be specified in the renditions
field. Default:\n ALL
.
Indicates which renditions are recorded for a stream, if renditionSelection
\n is CUSTOM
; otherwise, this field is irrelevant. The selected renditions are\n recorded if they are available during the stream. If a selected rendition is unavailable, the\n best available rendition is recorded. For details on the resolution dimensions of each\n rendition, see Auto-Record to Amazon S3.
Object that describes which renditions should be recorded for a stream.
" + } + }, + "com.amazonaws.ivs#RenditionConfigurationRendition": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "FULL_HD", + "name": "FULL_HD" + }, + { + "value": "HD", + "name": "HD" + }, + { + "value": "SD", + "name": "SD" + }, + { + "value": "LOWEST_RESOLUTION", + "name": "LOWEST_RESOLUTION" + } + ] + } + }, + "com.amazonaws.ivs#RenditionConfigurationRenditionList": { + "type": "list", + "member": { + "target": "com.amazonaws.ivs#RenditionConfigurationRendition" + } + }, + "com.amazonaws.ivs#RenditionConfigurationRenditionSelection": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ALL", + "name": "ALL" + }, + { + "value": "NONE", + "name": "NONE" + }, + { + "value": "CUSTOM", + "name": "CUSTOM" + } + ] + } + }, "com.amazonaws.ivs#ResourceArn": { "type": "string", "traits": { @@ -3300,6 +3389,12 @@ { "target": "com.amazonaws.ivs#InternalServerException" }, + { + "target": "com.amazonaws.ivs#PendingVerification" + }, + { + "target": "com.amazonaws.ivs#ResourceNotFoundException" + }, { "target": "com.amazonaws.ivs#ThrottlingException" }, @@ -3953,7 +4048,19 @@ "target": "com.amazonaws.ivs#TargetIntervalSeconds", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "The targeted thumbnail-generation interval in seconds. This is configurable (and required)\n only if recordingMode
is INTERVAL
. Default: 60.
\n Important: Setting a value for\n targetIntervalSeconds
does not guarantee that thumbnails are generated at the\n specified interval. For thumbnails to be generated at the targetIntervalSeconds
\n interval, the IDR/Keyframe
value for the input video must be less than the\n targetIntervalSeconds
value. See Amazon IVS Streaming Configuration\n for information on setting IDR/Keyframe
to the recommended value in video-encoder\n settings.
The targeted thumbnail-generation interval in seconds. This is configurable (and required)\n only if recordingMode
is INTERVAL
. Default: 60.
\n Important: For the BASIC
channel type,\n setting a value for targetIntervalSeconds
does not guarantee that thumbnails are\n generated at the specified interval. For thumbnails to be generated at the\n targetIntervalSeconds
interval, the IDR/Keyframe
value for the\n input video must be less than the targetIntervalSeconds
value. See Amazon IVS Streaming\n Configuration for information on setting IDR/Keyframe
to the\n recommended value in video-encoder settings.
Indicates the desired resolution of recorded thumbnails. Thumbnails are recorded at the\n selected resolution if the corresponding rendition is available during the stream; otherwise,\n they are recorded at source resolution. For more information about resolution values and their\n corresponding height and width dimensions, see Auto-Record to Amazon S3. Default:\n Null (source resolution is returned).
" + } + }, + "storage": { + "target": "com.amazonaws.ivs#ThumbnailConfigurationStorageList", + "traits": { + "smithy.api#documentation": "Indicates the format in which thumbnails are recorded. SEQUENTIAL
records all\n generated thumbnails in a serial manner, to the media/thumbnails directory.\n LATEST
saves the latest thumbnail in media/latest_thumbnail/thumb.jpg and\n overwrites it at the interval specified by targetIntervalSeconds
. You can enable\n both SEQUENTIAL
and LATEST
. Default: SEQUENTIAL
.
An object representing a configuration of thumbnails for recorded video.
" } }, + "com.amazonaws.ivs#ThumbnailConfigurationResolution": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "FULL_HD", + "name": "FULL_HD" + }, + { + "value": "HD", + "name": "HD" + }, + { + "value": "SD", + "name": "SD" + }, + { + "value": "LOWEST_RESOLUTION", + "name": "LOWEST_RESOLUTION" + } + ] + } + }, + "com.amazonaws.ivs#ThumbnailConfigurationStorage": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SEQUENTIAL", + "name": "SEQUENTIAL" + }, + { + "value": "LATEST", + "name": "LATEST" + } + ] + } + }, + "com.amazonaws.ivs#ThumbnailConfigurationStorageList": { + "type": "list", + "member": { + "target": "com.amazonaws.ivs#ThumbnailConfigurationStorage" + } + }, "com.amazonaws.ivs#Time": { "type": "timestamp", "traits": {