Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateChannel

Updates a channel's configuration. This does not affect an ongoing stream of this channel. You must stop and restart the stream for the changes to take effect.

Request Syntax


POST /UpdateChannel HTTP/1.1
Content-type: application/json

{
   "arn": "string",
   "authorized": boolean,
   "latencyMode": "string",
   "name": "string",
   "type": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

arn

ARN of the channel to be updated.

Type: String

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

authorized

Whether the channel is authorized.

Type: Boolean

Required: No

latencyMode

Channel latency mode. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)

Type: String

Valid Values: NORMAL | LOW

Required: No

name

Channel name.

Type: String

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

Pattern: ^[a-zA-Z0-9-_]*$

Required: No

type

Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. Valid values:

STANDARD: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Vertical resolution can be up to 1080 and bitrate can be up to 8.5 Mbps.
BASIC: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Vertical resolution can be up to 480 and bitrate can be up to 1.5 Mbps.

Type: String

Valid Values: BASIC | STANDARD

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "channel": { 
      "arn": "string",
      "authorized": boolean,
      "ingestEndpoint": "string",
      "latencyMode": "string",
      "name": "string",
      "playbackUrl": "string",
      "tags": { 
         "string" : "string" 
      },
      "type": "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.

channel

Object specifying a channel.

Type: Channel object

Errors

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

AccessDeniedException: HTTP Status Code: 403
ConflictException: HTTP Status Code: 409
PendingVerification: HTTP Status Code: 403
ResourceNotFoundException: HTTP Status Code: 404
ValidationException: HTTP Status Code: 400