Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

UpdateChannel

Important

CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.

Updates a channel specified by a required channel ARN or UUID.

Request Syntax


{
   "Channel": "string",
   "Destinations": [ 
      { 
         "Location": "string",
         "Type": "string"
      }
   ],
   "Name": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Channel

The ARN or ID (the ARN suffix) of the channel that you want to update.

Type: String

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

Pattern: ^[a-zA-Z0-9._/\-:]+$

Required: Yes

Destinations

The ARNs of event data stores that you want to log events arriving through the channel.

Type: Array of Destination objects

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

Required: No

Name

Changes the name of the channel.

Type: String

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

Pattern: ^[a-zA-Z0-9._\-]+$

Required: No

Response Syntax


{
   "ChannelArn": "string",
   "Destinations": [ 
      { 
         "Location": "string",
         "Type": "string"
      }
   ],
   "Name": "string",
   "Source": "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.

ChannelArn

The ARN of the channel that was updated.

Type: String

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

Pattern: ^[a-zA-Z0-9._/\-:]+$

Destinations

The event data stores that log events arriving through the channel.

Type: Array of Destination objects

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

Name

The name of the channel that was updated.

Type: String

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

Pattern: ^[a-zA-Z0-9._\-]+$

Source

The event source of the channel that was updated.

Type: String

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

Pattern: .*

Errors

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

ChannelAlreadyExistsException

This exception is thrown when the provided channel already exists.

HTTP Status Code: 400

ChannelARNInvalidException

This exception is thrown when the specified value of ChannelARN is not valid.

HTTP Status Code: 400

ChannelNotFoundException

This exception is thrown when CloudTrail cannot find the specified channel.

HTTP Status Code: 400

EventDataStoreARNInvalidException

The specified event data store ARN is not valid or does not map to an event data store in your account.

HTTP Status Code: 400

EventDataStoreNotFoundException

The specified event data store was not found.

HTTP Status Code: 400

InactiveEventDataStoreException

The event data store is inactive.

HTTP Status Code: 400

InvalidEventDataStoreCategoryException

This exception is thrown when event categories of specified event data stores are not valid.

HTTP Status Code: 400

InvalidParameterException

The request includes a parameter that is not valid.

HTTP Status Code: 400

OperationNotPermittedException

This exception is thrown when the requested operation is not permitted.

HTTP Status Code: 400

UnsupportedOperationException

This exception is thrown when the requested operation is not supported.

HTTP Status Code: 400