AWS cli documentation change
Summary
Updated AWS CLI version from 2.34.34 to 2.34.37, reordered parameters, added new --ad-configuration-arn parameter, updated parameter descriptions and constraints, and restructured output fields.
Security assessment
The changes include updates to security-related features like playback-restriction-policy-arn and recording-configuration-arn with improved pattern constraints, but there's no evidence of addressing a specific security vulnerability. The addition of ad-configuration-arn is a feature enhancement. Security documentation is added/updated for playback restriction and recording configuration features.
Diff
diff --git a/cli/latest/reference/ivs/update-channel.md b/cli/latest/reference/ivs/update-channel.md index 5714740cd..62c172d4f 100644 --- a//cli/latest/reference/ivs/update-channel.md +++ b//cli/latest/reference/ivs/update-channel.md @@ -15 +15 @@ - * [AWS CLI 2.34.34 Command Reference](../../index.html) » + * [AWS CLI 2.34.37 Command Reference](../../index.html) » @@ -68,0 +69,3 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/ivs-20 + [--name <value>] + [--latency-mode <value>] + [--type <value>] @@ -70 +73 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/ivs-20 - [--container-format <value>] + [--recording-configuration-arn <value>] @@ -72,4 +74,0 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/ivs-20 - [--latency-mode <value>] - [--multitrack-input-configuration <value>] - [--name <value>] - [--playback-restriction-policy-arn <value>] @@ -77,2 +76,4 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/ivs-20 - [--recording-configuration-arn <value>] - [--type <value>] + [--playback-restriction-policy-arn <value>] + [--multitrack-input-configuration <value>] + [--container-format <value>] + [--ad-configuration-arn <value>] @@ -112 +113,37 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/ivs-20 -> * pattern: `^arn:aws:ivs:[a-z0-9-]+:[0-9]+:channel/[a-zA-Z0-9-]+$` +> * pattern: `arn:aws:ivs:[a-z0-9-]+:[0-9]+:channel/[a-zA-Z0-9-]+` +> + + +`--name` (string) + +> Channel name. +> +> Constraints: +> +> * min: `0` +> * max: `128` +> * pattern: `[a-zA-Z0-9-_]*` +> + + +`--latency-mode` (string) + +> Channel latency mode. Use `NORMAL` to broadcast and deliver live video up to Full HD. Use `LOW` for near-real-time interaction with viewers. +> +> Possible values: +> +> * `NORMAL` +> * `LOW` +> + + +`--type` (string) + +> Channel type, which determines the allowable resolution and bitrate. _If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately._ Default: `STANDARD` . For details, see [Channel Types](https://docs.aws.amazon.com/ivs/latest/LowLatencyAPIReference/channel-types.html) . +> +> Possible values: +> +> * `BASIC` +> * `STANDARD` +> * `ADVANCED_SD` +> * `ADVANCED_HD` @@ -120 +157 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/ivs-20 -`--container-format` (string) +`--recording-configuration-arn` (string) @@ -122 +159 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/ivs-20 -> Indicates which content-packaging format is used (MPEG-TS or fMP4). If `multitrackInputConfiguration` is specified and `enabled` is `true` , then `containerFormat` is required and must be set to `FRAGMENTED_MP4` . Otherwise, `containerFormat` may be set to `TS` or `FRAGMENTED_MP4` . Default: `TS` . +> Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. If this is set to an empty string, recording is disabled. @@ -124 +161 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/ivs-20 -> Possible values: +> Constraints: @@ -126,2 +163,3 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/ivs-20 -> * `TS` -> * `FRAGMENTED_MP4` +> * min: `0` +> * max: `128` +> * pattern: `^$|^arn:aws:ivs:[a-z0-9-]+:[0-9]+:recording-configuration/[a-zA-Z0-9-]+$` @@ -135 +173 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/ivs-20 -`--latency-mode` (string) +`--preset` (string) @@ -137 +175 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/ivs-20 -> Channel latency mode. Use `NORMAL` to broadcast and deliver live video up to Full HD. Use `LOW` for near-real-time interaction with viewers. +> Optional transcode preset for the channel. This is selectable only for `ADVANCED_HD` and `ADVANCED_SD` channel types. For those channel types, the default `preset` is `HIGHER_BANDWIDTH_DELIVERY` . For other channel types (`BASIC` and `STANDARD` ), `preset` is the empty string (`""` ). @@ -141,2 +179,14 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/ivs-20 -> * `NORMAL` -> * `LOW` +> * `HIGHER_BANDWIDTH_DELIVERY` +> * `CONSTRAINED_BANDWIDTH_DELIVERY` +> + + +`--playback-restriction-policy-arn` (string) + +> Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. If this is set to an empty string, playback restriction policy is disabled. +> +> Constraints: +> +> * min: `0` +> * max: `128` +> * pattern: `^$|^arn:aws:ivs:[a-z0-9-]+:[0-9]+:playback-restriction-policy/[a-zA-Z0-9-]+$` @@ -154 +204 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/ivs-20 -> maximumResolution -> (string) +> policy -> (string) @@ -156 +206 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/ivs-20 ->> Maximum resolution for multitrack input. Required if `enabled` is `true` . +>> Indicates whether multitrack input is allowed or required. Required if `enabled` is `true` . @@ -160,3 +210,2 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/ivs-20 ->> * `SD` ->> * `HD` ->> * `FULL_HD` +>> * `ALLOW` +>> * `REQUIRE` @@ -166 +215 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/ivs-20 -> policy -> (string) +> maximumResolution -> (string) @@ -168 +217 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/ivs-20 ->> Indicates whether multitrack input is allowed or required. Required if `enabled` is `true` . +>> Maximum resolution for multitrack input. Required if `enabled` is `true` . @@ -172,2 +221,3 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/ivs-20 ->> * `ALLOW` ->> * `REQUIRE` +>> * `SD` +>> * `HD` +>> * `FULL_HD` @@ -180 +230 @@ Shorthand Syntax: - enabled=boolean,maximumResolution=string,policy=string + enabled=boolean,policy=string,maximumResolution=string @@ -188,2 +238,2 @@ JSON Syntax: - "maximumResolution": "SD"|"HD"|"FULL_HD", - "policy": "ALLOW"|"REQUIRE" + "policy": "ALLOW"|"REQUIRE", + "maximumResolution": "SD"|"HD"|"FULL_HD" @@ -193,25 +243 @@ JSON Syntax: -`--name` (string) - -> Channel name. -> -> Constraints: -> -> * min: `0` -> * max: `128` -> * pattern: `^[a-zA-Z0-9-_]*$` -> - - -`--playback-restriction-policy-arn` (string) - -> Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. If this is set to an empty string, playback restriction policy is disabled. -> -> Constraints: -> -> * min: `0` -> * max: `128` -> * pattern: `^^$|^arn:aws:ivs:[a-z0-9-]+:[0-9]+:playback-restriction-policy/[a-zA-Z0-9-]+$$` -> - - -`--preset` (string) +`--container-format` (string) @@ -219 +245 @@ JSON Syntax: -> Optional transcode preset for the channel. This is selectable only for `ADVANCED_HD` and `ADVANCED_SD` channel types. For those channel types, the default `preset` is `HIGHER_BANDWIDTH_DELIVERY` . For other channel types (`BASIC` and `STANDARD` ), `preset` is the empty string (`""` ). +> Indicates which content-packaging format is used (MPEG-TS or fMP4). If `multitrackInputConfiguration` is specified and `enabled` is `true` , then `containerFormat` is required and must be set to `FRAGMENTED_MP4` . Otherwise, `containerFormat` may be set to `TS` or `FRAGMENTED_MP4` . Default: `TS` . @@ -223,2 +249,2 @@ JSON Syntax: -> * `HIGHER_BANDWIDTH_DELIVERY` -> * `CONSTRAINED_BANDWIDTH_DELIVERY` +> * `TS` +> * `FRAGMENTED_MP4` @@ -228 +254 @@ JSON Syntax: -`--recording-configuration-arn` (string) +`--ad-configuration-arn` (string) @@ -230 +256 @@ JSON Syntax: -> Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. If this is set to an empty string, recording is disabled. +> ARN of the ad configuration associated with the channel. @@ -236,14 +262 @@ JSON Syntax: -> * pattern: `^^$|^arn:aws:ivs:[a-z0-9-]+:[0-9]+:recording-configuration/[a-zA-Z0-9-]+$$` -> - - -`--type` (string) - -> Channel type, which determines the allowable resolution and bitrate. _If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately._ Default: `STANDARD` . For details, see [Channel Types](https://docs.aws.amazon.com/ivs/latest/LowLatencyAPIReference/channel-types.html) . -> -> Possible values: -> -> * `BASIC` -> * `STANDARD` -> * `ADVANCED_SD` -> * `ADVANCED_HD` +> * pattern: `^$|^arn:aws:ivs:[a-z0-9-]+:[0-9]+:ad-configuration/[a-zA-Z0-9-]+$` @@ -691 +704 @@ channel -> (structure) ->> * pattern: `^arn:aws:ivs:[a-z0-9-]+:[0-9]+:channel/[a-zA-Z0-9-]+$` +>> * pattern: `arn:aws:ivs:[a-z0-9-]+:[0-9]+:channel/[a-zA-Z0-9-]+` @@ -695,5 +708 @@ channel -> (structure) -> authorized -> (boolean) -> ->> Whether the channel is private (enabled for playback authorization). Default: `false` . ->