AWS cli documentation change
Summary
Updated AWS CLI reference documentation for the 'list-channels' command to add support for ad configuration filtering, fix regex patterns, reorder parameters, and update CLI version from 2.34.34 to 2.34.37
Security assessment
The changes are routine documentation updates including: 1) Adding new filter parameter for ad configurations, 2) Fixing regex patterns by removing unnecessary '^' and '$' anchors, 3) Reordering output fields in the response structure, 4) Updating CLI version references. No security vulnerabilities, incidents, or weaknesses are mentioned or addressed in these changes. The changes mention existing security-related features like playback authorization and insecure RTMP ingest, but these are not new additions.
Diff
diff --git a/cli/latest/reference/ivs/list-channels.md b/cli/latest/reference/ivs/list-channels.md index 3dcd636e9..9d828d0d5 100644 --- a//cli/latest/reference/ivs/list-channels.md +++ b//cli/latest/reference/ivs/list-channels.md @@ -14,2 +14,2 @@ - * [previous](import-playback-key-pair.html "import-playback-key-pair") | - * [AWS CLI 2.34.34 Command Reference](../../index.html) » + * [previous](list-ad-configurations.html "list-ad-configurations") | + * [AWS CLI 2.34.37 Command Reference](../../index.html) » @@ -22 +22 @@ - * [← import-playback-key-pair](import-playback-key-pair.html "previous chapter \(use the left arrow\)") / + * [← list-ad-configurations](list-ad-configurations.html "previous chapter \(use the left arrow\)") / @@ -71 +70,0 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/ivs-20 - [--filter-by-playback-restriction-policy-arn <value>] @@ -72,0 +72,2 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/ivs-20 + [--filter-by-playback-restriction-policy-arn <value>] + [--filter-by-ad-configuration-arn <value>] @@ -109 +110,13 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/ivs-20 -> * pattern: `^[a-zA-Z0-9-_]*$` +> * pattern: `[a-zA-Z0-9-_]*` +> + + +`--filter-by-recording-configuration-arn` (string) + +> Filters the channel list to match the specified recording-configuration ARN. +> +> Constraints: +> +> * min: `0` +> * max: `128` +> * pattern: `^$|^arn:aws:ivs:[a-z0-9-]+:[0-9]+:recording-configuration/[a-zA-Z0-9-]+$` @@ -121 +134 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/ivs-20 -> * pattern: `^^$|^arn:aws:ivs:[a-z0-9-]+:[0-9]+:playback-restriction-policy/[a-zA-Z0-9-]+$$` +> * pattern: `^$|^arn:aws:ivs:[a-z0-9-]+:[0-9]+:playback-restriction-policy/[a-zA-Z0-9-]+$` @@ -125 +138 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/ivs-20 -`--filter-by-recording-configuration-arn` (string) +`--filter-by-ad-configuration-arn` (string) @@ -127 +140 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/ivs-20 -> Filters the channel list to match the specified recording-configuration ARN. +> Filters the channel list to match the specified ad configuration ARN. @@ -133 +146 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/ivs-20 -> * pattern: `^^$|^arn:aws:ivs:[a-z0-9-]+:[0-9]+:recording-configuration/[a-zA-Z0-9-]+$$` +> * pattern: `^$|^arn:aws:ivs:[a-z0-9-]+:[0-9]+:ad-configuration/[a-zA-Z0-9-]+$` @@ -397,20 +410 @@ channels -> (list) ->>> * pattern: `^arn:aws:ivs:[a-z0-9-]+:[0-9]+:channel/[a-zA-Z0-9-]+$` ->>> - ->> ->> authorized -> (boolean) ->> ->>> Whether the channel is private (enabled for playback authorization). Default: `false` . ->> ->> insecureIngest -> (boolean) ->> ->>> Whether the channel allows insecure RTMP ingest. Default: `false` . ->> ->> latencyMode -> (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. Default: `LOW` . ->>> ->>> Possible values: ->>> ->>> * `NORMAL` ->>> * `LOW` +>>> * pattern: `arn:aws:ivs:[a-z0-9-]+:[0-9]+:channel/[a-zA-Z0-9-]+` @@ -428 +422 @@ channels -> (list) ->>> * pattern: `^[a-zA-Z0-9-_]*$` +>>> * pattern: `[a-zA-Z0-9-_]*` @@ -432 +426 @@ channels -> (list) ->> playbackRestrictionPolicyArn -> (string) +>> latencyMode -> (string) @@ -434 +428 @@ channels -> (list) ->>> 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). +>>> Channel latency mode. Use `NORMAL` to broadcast and deliver live video up to Full HD. Use `LOW` for near-real-time interaction with viewers. Default: `LOW` . @@ -436 +430 @@ channels -> (list) ->>> Constraints: +>>> Possible values: @@ -438,3 +432,2 @@ channels -> (list) ->>> * min: `0` ->>> * max: `128` ->>> * pattern: `^^$|^arn:aws:ivs:[a-z0-9-]+:[0-9]+:playback-restriction-policy/[a-zA-Z0-9-]+$$` +>>> * `NORMAL` +>>> * `LOW` @@ -444 +437 @@ channels -> (list) ->> preset -> (string) +>> authorized -> (boolean) @@ -446,8 +439 @@ channels -> (list) ->>> 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 (`""` ). ->>> ->>> Possible values: ->>> ->>> * `HIGHER_BANDWIDTH_DELIVERY` ->>> * `CONSTRAINED_BANDWIDTH_DELIVERY` ->>> - +>>> Whether the channel is private (enabled for playback authorization). Default: `false` . @@ -463 +449 @@ channels -> (list) ->>> * pattern: `^^$|^arn:aws:ivs:[a-z0-9-]+:[0-9]+:recording-configuration/[a-zA-Z0-9-]+$$` +>>> * pattern: `^$|^arn:aws:ivs:[a-z0-9-]+:[0-9]+:recording-configuration/[a-zA-Z0-9-]+$` @@ -494,0 +481,4 @@ channels -> (list) +>> +>> insecureIngest -> (boolean) +>> +>>> Whether the channel allows insecure RTMP ingest. Default: `false` . @@ -507,0 +498,35 @@ channels -> (list) +>> +>> preset -> (string) +>> +>>> 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 (`""` ). +>>> +>>> Possible values: +>>> +>>> * `HIGHER_BANDWIDTH_DELIVERY` +>>> * `CONSTRAINED_BANDWIDTH_DELIVERY` +>>> + +>> +>> playbackRestrictionPolicyArn -> (string) +>> +>>> 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-]+$` +>>> + +>> +>> adConfigurationArn -> (string) +>> +>>> ARN of the ad configuration associated with the channel. +>>> +>>> Constraints: +>>> +>>> * min: `0` +>>> * max: `128` +>>> * pattern: `^$|^arn:aws:ivs:[a-z0-9-]+:[0-9]+:ad-configuration/[a-zA-Z0-9-]+$` +>>> + @@ -517 +542 @@ nextToken -> (string) -> * pattern: `^[a-zA-Z0-9+/=_-]*$` +> * pattern: `[a-zA-Z0-9+/=_-]*` @@ -521 +546 @@ nextToken -> (string) - * [← import-playback-key-pair](import-playback-key-pair.html "previous chapter \(use the left arrow\)") / + * [← list-ad-configurations](list-ad-configurations.html "previous chapter \(use the left arrow\)") / @@ -530,2 +555,2 @@ nextToken -> (string) - * [previous](import-playback-key-pair.html "import-playback-key-pair") | - * [AWS CLI 2.34.34 Command Reference](../../index.html) » + * [previous](list-ad-configurations.html "list-ad-configurations") | + * [AWS CLI 2.34.37 Command Reference](../../index.html) »