Amazonka.ChimeSDKMessaging.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.

Creating a Request

data SearchChannels

See: newSearchChannels smart constructor.

Constructors

SearchChannels'

Fields

• chimeBearer :: Maybe Text

  The AppInstanceUserArn of the user making the API call.

• maxResults :: Maybe Natural

  The maximum number of channels that you want returned.

• nextToken :: Maybe (Sensitive Text)

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

• fields :: NonEmpty SearchField

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

Instances

ToJSON SearchChannels

Defined in Amazonka.ChimeSDKMessaging.SearchChannels

Methods

toJSON :: SearchChannels -> Value

toEncoding :: SearchChannels -> Encoding

toJSONList :: [SearchChannels] -> Value

toEncodingList :: [SearchChannels] -> Encoding

ToHeaders SearchChannels

Defined in Amazonka.ChimeSDKMessaging.SearchChannels

Methods

toHeaders :: SearchChannels -> [Header]

ToPath SearchChannels

Defined in Amazonka.ChimeSDKMessaging.SearchChannels

Methods

toPath :: SearchChannels -> ByteString

ToQuery SearchChannels

Defined in Amazonka.ChimeSDKMessaging.SearchChannels

Methods

toQuery :: SearchChannels -> QueryString

AWSRequest SearchChannels

Defined in Amazonka.ChimeSDKMessaging.SearchChannels

Associated Types

type AWSResponse SearchChannels

Methods

request :: (Service -> Service) -> SearchChannels -> Request SearchChannels

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy SearchChannels -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SearchChannels)))

Generic SearchChannels

Defined in Amazonka.ChimeSDKMessaging.SearchChannels

Associated Types

type Rep SearchChannels :: Type -> Type

Methods

from :: SearchChannels -> Rep SearchChannels x

to :: Rep SearchChannels x -> SearchChannels

Show SearchChannels

Defined in Amazonka.ChimeSDKMessaging.SearchChannels

Methods

showsPrec :: Int -> SearchChannels -> ShowS

show :: SearchChannels -> String

showList :: [SearchChannels] -> ShowS

NFData SearchChannels

Defined in Amazonka.ChimeSDKMessaging.SearchChannels

Methods

rnf :: SearchChannels -> ()

Eq SearchChannels

Defined in Amazonka.ChimeSDKMessaging.SearchChannels

Methods

(==) :: SearchChannels -> SearchChannels -> Bool

(/=) :: SearchChannels -> SearchChannels -> Bool

Hashable SearchChannels

Defined in Amazonka.ChimeSDKMessaging.SearchChannels

Methods

hashWithSalt :: Int -> SearchChannels -> Int

hash :: SearchChannels -> Int

type AWSResponse SearchChannels

Defined in Amazonka.ChimeSDKMessaging.SearchChannels

type AWSResponse SearchChannels = SearchChannelsResponse

type Rep SearchChannels

Defined in Amazonka.ChimeSDKMessaging.SearchChannels

type Rep SearchChannels = D1 ('MetaData "SearchChannels" "Amazonka.ChimeSDKMessaging.SearchChannels" "amazonka-chime-sdk-messaging-2.0-BxY1AbjLoDB4AQUv82PCQZ" 'False) (C1 ('MetaCons "SearchChannels'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "chimeBearer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "fields") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty SearchField)))))

newSearchChannels

Arguments

:: NonEmpty SearchField

$sel:fields:SearchChannels'

-> SearchChannels

Create a value of SearchChannels with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:chimeBearer:SearchChannels', searchChannels_chimeBearer - The AppInstanceUserArn of the user making the API call.

$sel:maxResults:SearchChannels', searchChannels_maxResults - The maximum number of channels that you want returned.

SearchChannels, searchChannels_nextToken - The token returned from previous API requests until the number of channels is reached.

$sel:fields:SearchChannels', searchChannels_fields - A list of the Field objects in the channel being searched.

Request Lenses

searchChannels_chimeBearer :: Lens' SearchChannels (Maybe Text)

The AppInstanceUserArn of the user making the API call.

searchChannels_maxResults :: Lens' SearchChannels (Maybe Natural)

The maximum number of channels that you want returned.

searchChannels_nextToken :: Lens' SearchChannels (Maybe Text)

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

searchChannels_fields :: Lens' SearchChannels (NonEmpty SearchField)

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

Destructuring the Response

data SearchChannelsResponse

See: newSearchChannelsResponse smart constructor.

Constructors

SearchChannelsResponse'

Fields

• channels :: Maybe [ChannelSummary]

  A list of the channels in the request.

• nextToken :: Maybe (Sensitive Text)

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

• httpStatus :: Int

  The response's http status code.

Instances

Generic SearchChannelsResponse

Defined in Amazonka.ChimeSDKMessaging.SearchChannels

Associated Types

type Rep SearchChannelsResponse :: Type -> Type

Methods

from :: SearchChannelsResponse -> Rep SearchChannelsResponse x

to :: Rep SearchChannelsResponse x -> SearchChannelsResponse

Show SearchChannelsResponse

Defined in Amazonka.ChimeSDKMessaging.SearchChannels

Methods

showsPrec :: Int -> SearchChannelsResponse -> ShowS

show :: SearchChannelsResponse -> String

showList :: [SearchChannelsResponse] -> ShowS

NFData SearchChannelsResponse

Defined in Amazonka.ChimeSDKMessaging.SearchChannels

Methods

rnf :: SearchChannelsResponse -> ()

Eq SearchChannelsResponse

Defined in Amazonka.ChimeSDKMessaging.SearchChannels

Methods

(==) :: SearchChannelsResponse -> SearchChannelsResponse -> Bool

(/=) :: SearchChannelsResponse -> SearchChannelsResponse -> Bool

type Rep SearchChannelsResponse

Defined in Amazonka.ChimeSDKMessaging.SearchChannels

type Rep SearchChannelsResponse = D1 ('MetaData "SearchChannelsResponse" "Amazonka.ChimeSDKMessaging.SearchChannels" "amazonka-chime-sdk-messaging-2.0-BxY1AbjLoDB4AQUv82PCQZ" 'False) (C1 ('MetaCons "SearchChannelsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "channels") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ChannelSummary])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newSearchChannelsResponse

Arguments

:: Int

$sel:httpStatus:SearchChannelsResponse'

-> SearchChannelsResponse

Create a value of SearchChannelsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:channels:SearchChannelsResponse', searchChannelsResponse_channels - A list of the channels in the request.

SearchChannels, searchChannelsResponse_nextToken - The token returned from previous API responses until the number of channels is reached.

$sel:httpStatus:SearchChannelsResponse', searchChannelsResponse_httpStatus - The response's http status code.

Response Lenses

searchChannelsResponse_channels :: Lens' SearchChannelsResponse (Maybe [ChannelSummary])

A list of the channels in the request.

searchChannelsResponse_nextToken :: Lens' SearchChannelsResponse (Maybe Text)

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

searchChannelsResponse_httpStatus :: Lens' SearchChannelsResponse Int

The response's http status code.