CreateChannel
Used to create a channel. A channel collects data from an MQTT topic and archives the raw, unprocessed messages before publishing the data to a pipeline.
Request Syntax
POST /channels HTTP/1.1
Content-type: application/json
{
"channelName": "string
",
"channelStorage": {
"customerManagedS3": {
"bucket": "string
",
"keyPrefix": "string
",
"roleArn": "string
"
},
"serviceManagedS3": {
}
},
"retentionPeriod": {
"numberOfDays": number
,
"unlimited": boolean
},
"tags": [
{
"key": "string
",
"value": "string
"
}
]
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- channelName
-
The name of the channel.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
(^(?!_{2}))(^[a-zA-Z0-9_]+$)
Required: Yes
- channelStorage
-
Where channel data is stored. You can choose one of
serviceManagedS3
orcustomerManagedS3
storage. 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. When
customerManagedS3
storage is selected, this parameter is ignored.Type: RetentionPeriod object
Required: No
-
Metadata which can be used to manage the channel.
Type: Array of Tag objects
Array Members: Minimum number of 1 item. Maximum number of 50 items.
Required: No
Response Syntax
HTTP/1.1 201
Content-type: application/json
{
"channelArn": "string",
"channelName": "string",
"retentionPeriod": {
"numberOfDays": number,
"unlimited": boolean
}
}
Response Elements
If the action is successful, the service sends back an HTTP 201 response.
The following data is returned in JSON format by the service.
- channelArn
-
The ARN of the channel.
Type: String
- channelName
-
The name of the channel.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
(^(?!_{2}))(^[a-zA-Z0-9_]+$)
- retentionPeriod
-
How long, in days, message data is kept for the channel.
Type: RetentionPeriod object
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
- LimitExceededException
-
The command caused an internal limit to be exceeded.
HTTP Status Code: 410
- ResourceAlreadyExistsException
-
A resource with the same name already exists.
HTTP Status Code: 409
- 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: