BatchGetChannel - Amazon Interactive Video Service

BatchGetChannel

Performs GetChannel on multiple ARNs simultaneously.

Request Syntax

POST /BatchGetChannel HTTP/1.1 Content-type: application/json { "arns": [ "string" ] }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

arns

Array of ARNs, one per channel.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^arn:aws:[is]vs:[a-z0-9-]+:[0-9]+:channel/[a-zA-Z0-9-]+$

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "channels": [ { "arn": "string", "authorized": boolean, "ingestEndpoint": "string", "latencyMode": "string", "name": "string", "playbackUrl": "string", "tags": { "string" : "string" }, "type": "string" } ], "errors": [ { "arn": "string", "code": "string", "message": "string" } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

channels

Type: Array of Channel objects

errors

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

Type: Array of BatchError objects

Errors

For information about the errors that are common to all actions, see Common Errors.

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: