<a id="cli-aws-ivs-batch-get-channel"></a>

# batch-get-channel

## Description

Performs  GetChannel on multiple ARNs simultaneously.

See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/BatchGetChannel)

## Synopsis

```
  batch-get-channel
--arns <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]
```

## Options

`--arns` (list) [required]

> Array of ARNs, one per channel.

> Constraints:

> * min: `1`
> * max: `50`

> (string)

> > Constraints:

> > * min: `1`
> > * max: `128`
> > * pattern: `arn:aws:ivs:[a-z0-9-]+:[0-9]+:channel/[a-zA-Z0-9-]+`

Syntax:

```
"string" "string" ...
```

`--cli-input-json` | `--cli-input-yaml` (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by `--generate-cli-skeleton`. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with `--cli-input-yaml`.

`--generate-cli-skeleton` (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value `input`, prints a sample input JSON that can be used as an argument for `--cli-input-json`. Similarly, if provided `yaml-input` it will print a sample input YAML that can be used with `--cli-input-yaml`. If provided with the value `output`, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

## Global Options

`--debug` (boolean)

Turn on debug logging.

`--endpoint-url` (string)

Override command’s default URL with the given URL.

`--no-verify-ssl` (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

`--no-paginate` (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

`--output` (string)

The formatting style for command output.

* json
* text
* table
* yaml
* yaml-stream
* off

`--query` (string)

A JMESPath query to use in filtering the response data.

`--profile` (string)

Use a specific profile from your credential file.

`--region` (string)

The region to use. Overrides config/env settings.

`--version` (string)

Display the version of this tool.

`--color` (string)

Turn on/off color output.

* on
* off
* auto

`--no-sign-request` (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

`--ca-bundle` (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

`--cli-read-timeout` (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

`--cli-connect-timeout` (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

`--cli-binary-format` (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob `fileb://` will always be treated as binary and use the file contents directly regardless of the `cli-binary-format` setting. When using `file://` the file contents will need to properly formatted for the configured `cli-binary-format`.

* base64
* raw-in-base64-out

`--no-cli-pager` (boolean)

Disable cli pager for output.

`--cli-auto-prompt` (boolean)

Automatically prompt for CLI input parameters.

`--no-cli-auto-prompt` (boolean)

Disable automatically prompt for CLI input parameters.

`--cli-error-format` (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

* legacy
* json
* yaml
* text
* table
* enhanced

## Examples

#### NOTE
To use the following examples, you must have the AWS CLI installed and configured. See the [Getting started guide](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html) in the *AWS CLI User Guide* for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See [Using quotation marks with strings](https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-quoting-strings.html) in the *AWS CLI User Guide* .

**To get channel configuration information about multiple channels**

The following `batch-get-channel` example lists information about the specified channels.

```bash
aws ivs batch-get-channel \
    --arns arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh arn:aws:ivs:us-west-2:123456789012:channel/efghEFGHijkl
```

Output:

```json
{
    "channels": [
        {
            "arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
            "authorized": false,
            "containerFormat": "TS",
            "ingestEndpoint": "a1b2c3d4e5f6.global-contribute.live-video.net",
            "insecureIngest": false,
            "latencyMode": "LOW",
            "multitrackInputConfiguration": {
                "enabled": false,
                "maximumResolution": "FULL_HD",
                "policy": "ALLOW"
            },
            "name": "channel-1",
            "playbackUrl": "https://a1b2c3d4e5f6.us-west-2.playback.live-video.net/api/video/v1/us-west-2.123456789012.channel-1.abcdEFGH.m3u8",
            "preset": "",
            "playbackRestrictionPolicyArn": "",
            "recordingConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABCD12cdEFgh",
            "srt": {
                "endpoint": "a1b2c3d4e5f6.srt.live-video.net",
                "passphrase": "AB1C2defGHijkLMNo3PqQRstUvwxyzaBCDEfghh4ijklMN5opqrStuVWxyzAbCDEfghIJ"
            },
            "tags": {},
            "type": "STANDARD"
        },
        {
            "arn": "arn:aws:ivs:us-west-2:123456789012:channel/efghEFGHijkl",
            "authorized": false,
            "containerFormat": "FRAGMENTED_MP4",
            "ingestEndpoint": "a1b2c3d4e5f6.global-contribute.live-video.net",
            "insecureIngest": false,
            "latencyMode": "LOW",
            "multitrackInputConfiguration": {
                "enabled": true,
                "maximumResolution": "FULL_HD",
                "policy": "ALLOW"
            },
            "name": "channel-2",
            "playbackUrl": "https://a1b2c3d4e5f6.us-west-2.playback.live-video.net/api/video/v1/us-west-2.123456789012.channel-2.abcdEFGH.m3u8",
            "preset": "",
            "playbackRestrictionPolicyArn": "arn:aws:ivs:us-west-2:123456789012:playback-restriction-policy/ABcdef34ghIJ",
            "recordingConfigurationArn": "",
            "srt": {
                "endpoint": "a1b2c3d4e5f6.srt.live-video.net",
                "passphrase": "BA1C2defGHijkLMNo3PqQRstUvwxyzaBCDEfghh4ijklMN5opqrStuVWxyzAbCDEfghIJ"
            },
            "tags": {},
            "type": "STANDARD"
        }
    ]
}
```

For more information, see [Create a Channel](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started-create-channel.html) in the *IVS Low-Latency User Guide*.

## Output

accessControlAllowOrigin -> (string)

> See [Access-Control-Allow-Origin](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Access-Control-Allow-Origin) in the MDN Web Docs.

accessControlExposeHeaders -> (string)

> See [Access-Control-Expose-Headers](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Access-Control-Expose-Headers) in the MDN Web Docs.

cacheControl -> (string)

> See [Cache-Control](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Cache-Control) in the MDN Web Docs.

contentSecurityPolicy -> (string)

> See [Content-Security-Policy](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Content-Security-Policy) in the MDN Web Docs.

strictTransportSecurity -> (string)

> See [Strict-Transport-Security](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Strict-Transport-Security) in the MDN Web Docs.

xContentTypeOptions -> (string)

> See [X-Content-Type-Options](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/X-Content-Type-Options) in the MDN Web Docs.

xFrameOptions -> (string)

> See [X-Frame-Options](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/X-Frame-Options) in the MDN Web Docs.

channels -> (list)

> (structure)

> > Object specifying a channel.

> > arn -> (string)

> > > Channel ARN.

> > > Constraints:

> > > * min: `1`
> > > * max: `128`
> > > * 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-_]*`

> > 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`

> > 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/LowLatencyUserGuide/channel-types.html) .

> > > Possible values:

> > > * `BASIC`
> > > * `STANDARD`
> > > * `ADVANCED_SD`
> > > * `ADVANCED_HD`

> > 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-]+$`

> > ingestEndpoint -> (string)

> > > 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.

> > > Constraints:

> > > * min: `0`
> > > * max: `50`

> > > key -> (string)

> > > > Constraints:

> > > > * min: `1`
> > > > * max: `128`
> > > > * pattern: `([\p{L}\p{Z}\p{N}_.:/=+\-@]+)`

> > > value -> (string)

> > > > Constraints:

> > > > * min: `0`
> > > > * max: `256`
> > > > * pattern: `([\p{L}\p{Z}\p{N}_.:/=+\-@]*)`

> > insecureIngest -> (boolean)

> > > Whether the channel allows insecure RTMP ingest. Default: `false` .

> > 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`

> > srt -> (structure)

> > > Specifies the endpoint and optional passphrase for streaming with the SRT protocol.

> > > endpoint -> (string)

> > > > The endpoint to be used when streaming with IVS using the SRT protocol.

> > > passphrase -> (string)

> > > > Auto-generated passphrase to enable encryption. This field is applicable only if the end user has *not* enabled the `insecureIngest` option for the channel.

> > 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-]+$`

> > multitrackInputConfiguration -> (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` .

> > > policy -> (string)

> > > > Indicates whether multitrack input is allowed or required. Required if `enabled` is `true` .

> > > > Possible values:

> > > > * `ALLOW`
> > > > * `REQUIRE`

> > > maximumResolution -> (string)

> > > > Maximum resolution for multitrack input. Required if `enabled` is `true` .

> > > > Possible values:

> > > > * `SD`
> > > > * `HD`
> > > > * `FULL_HD`

> > containerFormat -> (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` .

> > > Possible values:

> > > * `TS`
> > > * `FRAGMENTED_MP4`

> > 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-]+$`

> > failoverSlateConfigurationArn -> (string)

> > > Failover-slate-configuration ARN. A valid ARN value here both specifies the ARN and enables failover slate. Default: “” (empty string, no failover slate configuration is applied).

> > > Constraints:

> > > * min: `0`
> > > * max: `128`
> > > * pattern: `^$|^arn:aws:ivs:[a-z0-9-]+:[0-9]+:failover-slate-configuration/[a-zA-Z0-9-]+$`

errors -> (list)

> Each error object is related to a specific ARN in the request.

> (structure)

> > Error related to a specific channel, specified by its ARN.

> > arn -> (string)

> > > ARN of an IVS resource; e.g., channel.

> > > Constraints:

> > > * min: `1`
> > > * max: `128`
> > > * pattern: `arn:aws:ivs:[a-z0-9-]+:[0-9]+:[a-z-]/[a-zA-Z0-9-]+`

> > code -> (string)

> > > Error code.

> > message -> (string)

> > > Error message, determined by the application.