SearchChannels - Amazon Chime SDK

SearchChannels

Allows ChimeBearer to search channels by channel members. AppInstanceUsers can search across the channels that they belong to. AppInstanceAdmins can search across all channels.

Request Syntax

POST /channels?operation=search&max-results=MaxResults&next-token=NextToken HTTP/1.1 x-amz-chime-bearer: ChimeBearer Content-type: application/json { "Fields": [ { "Key": "string", "Operator": "string", "Values": [ "string" ] } ] }

URI Request Parameters

The request uses the following URI parameters.

ChimeBearer

The AppInstanceUserArn of the user making the API call.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

MaxResults

The maximum number of channels that you want returned.

Valid Range: Minimum value of 1. Maximum value of 50.

NextToken

The token returned from previous API requests until the number of channels is reached.

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: .*

Request Body

The request accepts the following data in JSON format.

Fields

A list of the Field objects in the channel being searched.

Type: Array of SearchField objects

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

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "Channels": [ { "ChannelArn": "string", "LastMessageTimestamp": number, "Metadata": "string", "Mode": "string", "Name": "string", "Privacy": "string" } ], "NextToken": "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.

Channels

A list of the channels in the request.

Type: Array of ChannelSummary objects

NextToken

The token returned from previous API responses until the number of channels is reached.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: .*

Errors

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

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: