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

DescribeChannel

Retrieves information about a channel.

Request Syntax


GET /channels/channelName?includeStatistics=includeStatistics HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

channelName

The name of the channel whose information is retrieved.

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

Pattern: (^(?!_{2}))(^[a-zA-Z0-9_]+$)

Required: Yes

includeStatistics

If true, additional statistical information about the channel is included in the response. This feature can't be used with a channel whose S3 storage is customer-managed.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "channel": { 
      "arn": "string",
      "creationTime": number,
      "lastMessageArrivalTime": number,
      "lastUpdateTime": number,
      "name": "string",
      "retentionPeriod": { 
         "numberOfDays": number,
         "unlimited": boolean
      },
      "status": "string",
      "storage": { 
         "customerManagedS3": { 
            "bucket": "string",
            "keyPrefix": "string",
            "roleArn": "string"
         },
         "serviceManagedS3": { 
         }
      }
   },
   "statistics": { 
      "size": { 
         "estimatedOn": number,
         "estimatedSizeInBytes": number
      }
   }
}

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

An object that contains information about the channel.

Type: Channel object

statistics

Statistics about the channel. Included if the includeStatistics parameter is set to true in the request.

Type: ChannelStatistics 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

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