AWS cli documentation change
Summary
Updated AWS CLI version from 2.34.34 to 2.34.37, changed navigation links, removed regex anchors from ARN patterns, reordered and restructured channel response fields, added adConfigurationArn field, and updated field descriptions and constraints.
Security assessment
The changes are primarily documentation updates including version updates, field reordering, and pattern syntax corrections (removing ^ and $ anchors from ARN patterns). No evidence of addressing a specific security vulnerability or incident. The changes maintain existing security-related fields like authorized, insecureIngest, and playbackRestrictionPolicyArn but don't add new security documentation.
Diff
diff --git a/cli/latest/reference/ivs/get-channel.md b/cli/latest/reference/ivs/get-channel.md index 962aa9f73..f32973df7 100644 --- a//cli/latest/reference/ivs/get-channel.md +++ b//cli/latest/reference/ivs/get-channel.md @@ -14,2 +14,2 @@ - * [previous](delete-stream-key.html "delete-stream-key") | - * [AWS CLI 2.34.34 Command Reference](../../index.html) » + * [previous](get-ad-configuration.html "get-ad-configuration") | + * [AWS CLI 2.34.37 Command Reference](../../index.html) » @@ -22 +22 @@ - * [← delete-stream-key](delete-stream-key.html "previous chapter \(use the left arrow\)") / + * [← get-ad-configuration](get-ad-configuration.html "previous chapter \(use the left arrow\)") / @@ -102 +102 @@ 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-]+` @@ -279 +279 @@ 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-]+` @@ -283,5 +283 @@ channel -> (structure) -> authorized -> (boolean) -> ->> Whether the channel is private (enabled for playback authorization). Default: `false` . -> -> containerFormat -> (string) +> name -> (string) @@ -289 +285 @@ channel -> (structure) ->> 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. @@ -291 +287 @@ channel -> (structure) ->> Possible values: +>> Constraints: @@ -293,2 +289,3 @@ channel -> (structure) ->> * `TS` ->> * `FRAGMENTED_MP4` +>> * min: `0` +>> * max: `128` +>> * pattern: `[a-zA-Z0-9-_]*` @@ -297,8 +293,0 @@ channel -> (structure) -> -> ingestEndpoint -> (string) -> ->> Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software. -> -> insecureIngest -> (boolean) -> ->> Whether the channel allows insecure RTMP ingest. Default: `false` . @@ -317 +306 @@ channel -> (structure) -> multitrackInputConfiguration -> (structure) +> type -> (string) @@ -319,7 +308 @@ channel -> (structure) ->> Object specifying multitrack input configuration. Default: no multitrack input configuration is specified. ->> ->> enabled -> (boolean) ->> ->>> 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` . ->> ->> maximumResolution -> (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) . @@ -327,9 +310 @@ channel -> (structure) ->>> Maximum resolution for multitrack input. Required if `enabled` is `true` . ->>> ->>> Possible values: ->>> ->>> * `SD` ->>> * `HD` ->>> * `FULL_HD` ->>> - +>> Possible values: @@ -337 +312,4 @@ channel -> (structure) ->> policy -> (string) +>> * `BASIC` +>> * `STANDARD` +>> * `ADVANCED_SD` +>> * `ADVANCED_HD` @@ -339,7 +316,0 @@ channel -> (structure) ->>> Indicates whether multitrack input is allowed or required. Required if `enabled` is `true` . ->>> ->>> Possible values: ->>> ->>> * `ALLOW` ->>> * `REQUIRE` ->>> @@ -348 +319 @@ channel -> (structure) -> name -> (string) +> recordingConfigurationArn -> (string) @@ -350 +321 @@ channel -> (structure) ->> Channel name. +>> Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. Default: “” (empty string, recording is disabled). @@ -356 +327 @@ channel -> (structure) ->> * pattern: `^[a-zA-Z0-9-_]*$` +>> * pattern: `^$|^arn:aws:ivs:[a-z0-9-]+:[0-9]+:recording-configuration/[a-zA-Z0-9-]+$` @@ -360 +331 @@ channel -> (structure) -> playbackRestrictionPolicyArn -> (string) +> ingestEndpoint -> (string) @@ -362 +333,13 @@ channel -> (structure) ->> 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 ingest endpoint, part of the definition of an ingest server, used when you set up streaming software. +> +> playbackUrl -> (string) +> +>> Channel playback URL. +> +> authorized -> (boolean) +> +>> Whether the channel is private (enabled for playback authorization). Default: `false` . +> +> tags -> (map) +> +>> Tags attached to the resource. 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. @@ -367,2 +350 @@ channel -> (structure) ->> * max: `128` ->> * pattern: `^^$|^arn:aws:ivs:[a-z0-9-]+:[0-9]+:playback-restriction-policy/[a-zA-Z0-9-]+$$` +>> * max: `50` @@ -370,0 +353,18 @@ channel -> (structure) +>> +>> key -> (string) +>> +>>> Constraints: +>>> +>>> * min: `1` +>>> * max: `128` +>>> + +>> +>> value -> (string) +>> +>>> Constraints: +>>> +>>> * min: `0` +>>> * max: `256` +>>> + @@ -372 +372 @@ channel -> (structure) -> playbackUrl -> (string) +> insecureIngest -> (boolean) @@ -374 +374 @@ channel -> (structure) ->> Channel playback URL. +>> Whether the channel allows insecure RTMP ingest. Default: `false` . @@ -386,12 +385,0 @@ channel -> (structure) -> -> recordingConfigurationArn -> (string) -> ->> Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. Default: “” (empty string, recording is disabled). ->> ->> Constraints: ->> ->> * min: `0` ->> * max: `128` ->> * pattern: `^^$|^arn:aws:ivs:[a-z0-9-]+:[0-9]+:recording-configuration/[a-zA-Z0-9-]+$$` ->> - @@ -411 +399 @@ channel -> (structure) -> tags -> (map) +> playbackRestrictionPolicyArn -> (string) @@ -413 +401 @@ channel -> (structure) ->> Tags attached to the resource. 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. +>> 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). @@ -418 +406,2 @@ channel -> (structure) ->> * max: `50` +>> * max: `128` +>> * pattern: `^$|^arn:aws:ivs:[a-z0-9-]+:[0-9]+:playback-restriction-policy/[a-zA-Z0-9-]+$` @@ -420,0 +410,4 @@ channel -> (structure) +> +> multitrackInputConfiguration -> (structure) +> +>> Object specifying multitrack input configuration. Default: no multitrack input configuration is specified. @@ -422 +415 @@ channel -> (structure) ->> key -> (string) +>> enabled -> (boolean) @@ -424 +417,5 @@ channel -> (structure) ->>> Constraints: +>>> 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` . +>> +>> policy -> (string) +>> +>>> Indicates whether multitrack input is allowed or required. Required if `enabled` is `true` . @@ -426,2 +423,4 @@ channel -> (structure) ->>> * min: `1` ->>> * max: `128` +>>> Possible values: +>>> +>>> * `ALLOW` +>>> * `REQUIRE` @@ -431 +430 @@ channel -> (structure) ->> value -> (string) +>> maximumResolution -> (string) @@ -433 +432 @@ channel -> (structure) ->>> Constraints: +>>> Maximum resolution for multitrack input. Required if `enabled` is `true` . @@ -435,2 +434,5 @@ channel -> (structure) ->>> * min: `0` ->>> * max: `256` +>>> Possible values: +>>> +>>> * `SD` +>>> * `HD` +>>> * `FULL_HD` @@ -440 +442 @@ channel -> (structure) -> type -> (string)