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

GetChannel

Displays information about a channel in a private re:Post.

Request Syntax


GET /spaces/spaceId/channels/channelId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

channelId

The unique ID of the private re:Post channel.

Length Constraints: Fixed length of 24.

Required: Yes

spaceId

The unique ID of the private re:Post.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "channelDescription": "string",
   "channelId": "string",
   "channelName": "string",
   "channelRoles": { 
      "string" : [ "string" ]
   },
   "channelStatus": "string",
   "createDateTime": "string",
   "deleteDateTime": "string",
   "spaceId": "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.

channelDescription

A description for the channel. This is used only to help you identify this channel.

Type: String

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

channelId

The unique ID of the private re:Post channel.

Type: String

Length Constraints: Fixed length of 24.

channelName

The name for the channel. This must be unique per private re:Post.

Type: String

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

channelRoles

The channel roles associated to the users and groups of the channel.

Type: String to array of strings map

Valid Values: ASKER | EXPERT | MODERATOR | SUPPORTREQUESTOR

channelStatus

The status pf the channel.

Type: String

createDateTime

The date when the channel was created.

Type: Timestamp

deleteDateTime

The date when the channel was deleted.

Type: Timestamp

spaceId

The unique ID of the private re:Post.

Type: String

Errors

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

AccessDeniedException

User does not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

Unexpected error during processing of request.

retryAfterSeconds: Advice to clients on when the call can be safely retried.

HTTP Status Code: 500

ResourceNotFoundException

Request references a resource which does not exist.

resourceId: The ID of the resource.
resourceType: The type of the resource.

HTTP Status Code: 404

ThrottlingException

Request was denied due to request throttling.

quotaCode: The code to identify the quota.
retryAfterSeconds: Advice to clients on when the call can be safely retried.
serviceCode: The code to identify the service.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

fieldList: The field that caused the error, if applicable.
reason: The reason why the request failed validation.

HTTP Status Code: 400