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

UpdateChannel

Update the specified channel. You can edit if MediaPackage sends ingest or egress access logs to the CloudWatch log group, if content will be encrypted, the description on a channel, and your channel's policy settings. You can't edit the name of the channel or CloudFront distribution details.

Any edits you make that impact the video output may not be reflected for a few minutes.

Request Syntax


PUT /channelGroup/ChannelGroupName/channel/ChannelName/ HTTP/1.1
x-amzn-update-if-match: ETag
Content-type: application/json

{
   "Description": "string"
}

URI Request Parameters

The request uses the following URI parameters.

ChannelGroupName

The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

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

Pattern: [a-zA-Z0-9_-]+

Required: Yes

ChannelName

The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.

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

Pattern: [a-zA-Z0-9_-]+

Required: Yes

ETag

The expected current Entity Tag (ETag) for the resource. If the specified ETag does not match the resource's current entity tag, the update request will be rejected.

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

Pattern: [\S]+

Request Body

The request accepts the following data in JSON format.

Description

Any descriptive information that you want to add to the channel for future identification purposes.

Type: String

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

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Arn": "string",
   "ChannelGroupName": "string",
   "ChannelName": "string",
   "CreatedAt": number,
   "Description": "string",
   "ETag": "string",
   "IngestEndpoints": [ 
      { 
         "Id": "string",
         "Url": "string"
      }
   ],
   "ModifiedAt": number,
   "tags": { 
      "string" : "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.

Arn

The Amazon Resource Name (ARN) associated with the resource.

Type: String

ChannelGroupName

The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

Type: String

ChannelName

The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.

Type: String

CreatedAt

The date and time the channel was created.

Type: Timestamp

Description

The description for your channel.

Type: String

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

ETag

The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource.

Type: String

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

Pattern: [\S]+

IngestEndpoints

The list of ingest endpoints.

Type: Array of IngestEndpoint objects

ModifiedAt

The date and time the channel was modified.

Type: Timestamp

tags

The comma-separated list of tag key:value pairs assigned to the channel.

Type: String to string map

Errors

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

AccessDeniedException

You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access Management in the IAM User Guide.

HTTP Status Code: 403

ConflictException

Updating or deleting this resource can cause an inconsistent state.

HTTP Status Code: 409

InternalServerException

Indicates that an error from the service occurred while trying to process a request.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource doesn't exist.

HTTP Status Code: 404

ThrottlingException

The request throughput limit was exceeded.

HTTP Status Code: 429

ValidationException

The input failed to meet the constraints specified by the AWS service.

HTTP Status Code: 400