Used to update the settings of a channel.
Important
The UpdateChannel operation in AWS IoT Analytics is no longer available to new customers. Existing customers of AWS IoT Analytics can continue
to use the service as normal.
Learn more
Request Syntax
PUT /channels/channelName HTTP/1.1
Content-type: application/json
{
"channelStorage": {
"customerManagedS3": {
"bucket": "string",
"keyPrefix": "string",
"roleArn": "string"
},
"serviceManagedS3": {
}
},
"retentionPeriod": {
"numberOfDays": number,
"unlimited": boolean
}
}URI Request Parameters
The request uses the following URI parameters.
- channelName
-
The name of the channel to be updated.
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
(^(?!_{2}))(^[a-zA-Z0-9_]+$)Required: Yes
Request Body
The request accepts the following data in JSON format.
- channelStorage
-
Where channel data is stored. You can choose one of
serviceManagedS3orcustomerManagedS3storage. If not specified, the default isserviceManagedS3. You can't change this storage option after the channel is created.Type: ChannelStorage object
Required: No
- retentionPeriod
-
How long, in days, message data is kept for the channel. The retention period can't be updated if the channel's Amazon S3 storage is customer-managed.
Type: RetentionPeriod object
Required: No
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalFailureException
-
There was an internal failure.
HTTP Status Code: 500
- InvalidRequestException
-
The request was not valid.
HTTP Status Code: 400
- ResourceNotFoundException
-
A resource with the specified name could not be found.
HTTP Status Code: 404
- ServiceUnavailableException
-
The service is temporarily unavailable.
HTTP Status Code: 503
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
