AWS cli documentation change
Summary
Updated AWS CLI reference documentation for IVS create-channel command, including reordering of parameters, addition of ad-configuration-arn parameter, pattern format changes for ARNs, and updates to parameter descriptions and constraints.
Security assessment
The changes are primarily documentation reorganization and feature updates. No evidence of security vulnerability fixes or incident response. Changes include reordering parameters, adding ad-configuration support, updating ARN pattern formats (removing '^' and '$' anchors), and adjusting parameter descriptions. The 'insecure-ingest' parameter documentation remains unchanged, and no new security features are documented beyond existing playback authorization and insecure ingest controls.
Diff
diff --git a/cli/latest/reference/ivs/create-channel.md b/cli/latest/reference/ivs/create-channel.md index 0619837c3..c34f562de 100644 --- a//cli/latest/reference/ivs/create-channel.md +++ b//cli/latest/reference/ivs/create-channel.md @@ -14,2 +14,2 @@ - * [previous](batch-start-viewer-session-revocation.html "batch-start-viewer-session-revocation") | - * [AWS CLI 2.34.34 Command Reference](../../index.html) » + * [previous](create-ad-configuration.html "create-ad-configuration") | + * [AWS CLI 2.34.37 Command Reference](../../index.html) » @@ -22 +22 @@ - * [← batch-start-viewer-session-revocation](batch-start-viewer-session-revocation.html "previous chapter \(use the left arrow\)") / + * [← create-ad-configuration](create-ad-configuration.html "previous chapter \(use the left arrow\)") / @@ -68,5 +67,0 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/ivs-20 - [--authorized | --no-authorized] - [--container-format <value>] - [--insecure-ingest | --no-insecure-ingest] - [--latency-mode <value>] - [--multitrack-input-configuration <value>] @@ -74,2 +69,3 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/ivs-20 - [--playback-restriction-policy-arn <value>] - [--preset <value>] + [--latency-mode <value>] + [--type <value>] + [--authorized | --no-authorized] @@ -78 +74,6 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/ivs-20 - [--type <value>] + [--insecure-ingest | --no-insecure-ingest] + [--preset <value>] + [--playback-restriction-policy-arn <value>] + [--multitrack-input-configuration <value>] + [--container-format <value>] + [--ad-configuration-arn <value>] @@ -104,5 +105 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/ivs-20 -`--authorized` | `--no-authorized` (boolean) - -> Whether the channel is private (enabled for playback authorization). Default: `false` . - -`--container-format` (string) +`--name` (string) @@ -110 +107 @@ 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` . +> Channel name. @@ -112 +109 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/ivs-20 -> Possible values: +> Constraints: @@ -114,2 +111,3 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/ivs-20 -> * `TS` -> * `FRAGMENTED_MP4` +> * min: `0` +> * max: `128` +> * pattern: `[a-zA-Z0-9-_]*` @@ -119,4 +116,0 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/ivs-20 -`--insecure-ingest` | `--no-insecure-ingest` (boolean) - -> Whether the channel allows insecure RTMP and SRT ingest. Default: `false` . - @@ -134 +128 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/ivs-20 -`--multitrack-input-configuration` (structure) +`--type` (string) @@ -136 +130 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/ivs-20 -> Object specifying multitrack input configuration. Default: no multitrack input configuration is specified. +> 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) . @@ -138 +132 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/ivs-20 -> enabled -> (boolean) +> Possible values: @@ -140 +134,4 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/ivs-20 ->> Indicates whether multitrack input is enabled. Can be set to `true` only if channel type is `STANDARD` . Setting `enabled` to `true` with any other channel type will cause an exception. If `true` , then `policy` , `maximumResolution` , and `containerFormat` are required, and `containerFormat` must be set to `FRAGMENTED_MP4` . Default: `false` . +> * `BASIC` +> * `STANDARD` +> * `ADVANCED_SD` +> * `ADVANCED_HD` @@ -142 +139,9 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/ivs-20 -> maximumResolution -> (string) + + +`--authorized` | `--no-authorized` (boolean) + +> Whether the channel is private (enabled for playback authorization). Default: `false` . + +`--recording-configuration-arn` (string) + +> Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. Default: “” (empty string, recording is disabled). @@ -144,3 +149,22 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/ivs-20 ->> Maximum resolution for multitrack input. Required if `enabled` is `true` . ->> ->> Possible values: +> Constraints: +> +> * min: `0` +> * max: `128` +> * pattern: `^$|^arn:aws:ivs:[a-z0-9-]+:[0-9]+:recording-configuration/[a-zA-Z0-9-]+$` +> + + +`--tags` (map) + +> Array of 1-50 maps, each of the form `string:string (key:value)` . See [Best practices and strategies](https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html) 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. +> +> Constraints: +> +> * min: `0` +> * max: `50` +> + +> +> key -> (string) +> +>> Constraints: @@ -148,3 +172,2 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/ivs-20 ->> * `SD` ->> * `HD` ->> * `FULL_HD` +>> * min: `1` +>> * max: `128` @@ -154 +177 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/ivs-20 -> policy -> (string) +> value -> (string) @@ -156,3 +179 @@ 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` . ->> ->> Possible values: +>> Constraints: @@ -160,2 +181,2 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/ivs-20 ->> * `ALLOW` ->> * `REQUIRE` +>> * min: `0` +>> * max: `256` @@ -168 +189 @@ Shorthand Syntax: - enabled=boolean,maximumResolution=string,policy=string + KeyName1=string,KeyName2=string @@ -174,18 +195,2 @@ JSON Syntax: - { - "enabled": true|false, - "maximumResolution": "SD"|"HD"|"FULL_HD", - "policy": "ALLOW"|"REQUIRE" - } - - -`--name` (string) - -> Channel name. -> -> Constraints: -> -> * min: `0` -> * max: `128` -> * pattern: `^[a-zA-Z0-9-_]*$` -> - + {"string": "string" + ...} @@ -193 +197,0 @@ JSON Syntax: -`--playback-restriction-policy-arn` (string) @@ -195,8 +199 @@ JSON Syntax: -> 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). -> -> Constraints: -> -> * min: `0` -> * max: `128` -> * pattern: `^^$|^arn:aws:ivs:[a-z0-9-]+:[0-9]+:playback-restriction-policy/[a-zA-Z0-9-]+$$` -> +`--insecure-ingest` | `--no-insecure-ingest` (boolean) @@ -203,0 +201 @@ JSON Syntax: +> Whether the channel allows insecure RTMP and SRT ingest. Default: `false` . @@ -216 +214 @@ JSON Syntax: -`--recording-configuration-arn` (string) +`--playback-restriction-policy-arn` (string) @@ -218 +216 @@ JSON Syntax: -> Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. Default: “” (empty string, recording is disabled). +> 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). @@ -224 +222 @@ JSON Syntax: -> * pattern: `^^$|^arn:aws:ivs:[a-z0-9-]+:[0-9]+:recording-configuration/[a-zA-Z0-9-]+$$` +> * pattern: `^$|^arn:aws:ivs:[a-z0-9-]+:[0-9]+:playback-restriction-policy/[a-zA-Z0-9-]+$` @@ -228 +226 @@ JSON Syntax: -`--tags` (map) +`--multitrack-input-configuration` (structure) @@ -230,3 +228 @@ JSON Syntax: -> Array of 1-50 maps, each of the form `string:string (key:value)` . See [Best practices and strategies](https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html) 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. -> -> Constraints: +> Object specifying multitrack input configuration. Default: no multitrack input configuration is specified. @@ -234,2 +230 @@ JSON Syntax: -> * min: `0` -> * max: `50` +> enabled -> (boolean) @@ -237 +232 @@ JSON Syntax: - +>> Indicates whether multitrack input is enabled. Can be set to `true` only if channel type is `STANDARD` . Setting `enabled` to `true` with any other channel type will cause an exception. If `true` , then `policy` , `maximumResolution` , and `containerFormat` are required, and `containerFormat` must be set to `FRAGMENTED_MP4` . Default: `false` . @@ -239 +234 @@ JSON Syntax: -> key -> (string) +> policy -> (string) @@ -241 +236 @@ JSON Syntax: ->> Constraints: +>> Indicates whether multitrack input is allowed or required. Required if `enabled` is `true` . @@ -243,2 +238,4 @@ JSON Syntax: ->> * min: `1` ->> * max: `128` +>> Possible values: +>>