Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.ChimeSDKMessaging.ListChannels

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists all Channels created under a single Chime App as a paginated list. You can specify filters to narrow results.

Functionality & restrictions

Use privacy = PUBLIC to retrieve all public channels in the account.
Only an AppInstanceAdmin can set privacy = PRIVATE to list the private channels in an account.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

Synopsis

data ListChannels = ListChannels' {
- privacy :: Maybe ChannelPrivacy
- nextToken :: Maybe (Sensitive Text)
- maxResults :: Maybe Natural
- appInstanceArn :: Text
- chimeBearer :: Text
}
newListChannels :: Text -> Text -> ListChannels
listChannels_privacy :: Lens' ListChannels (Maybe ChannelPrivacy)
listChannels_nextToken :: Lens' ListChannels (Maybe Text)
listChannels_maxResults :: Lens' ListChannels (Maybe Natural)
listChannels_appInstanceArn :: Lens' ListChannels Text
listChannels_chimeBearer :: Lens' ListChannels Text
data ListChannelsResponse = ListChannelsResponse' {
- channels :: Maybe [ChannelSummary]
- nextToken :: Maybe (Sensitive Text)
- httpStatus :: Int
}
newListChannelsResponse :: Int -> ListChannelsResponse
listChannelsResponse_channels :: Lens' ListChannelsResponse (Maybe [ChannelSummary])
listChannelsResponse_nextToken :: Lens' ListChannelsResponse (Maybe Text)
listChannelsResponse_httpStatus :: Lens' ListChannelsResponse Int

Creating a Request

data ListChannels Source #

See: newListChannels smart constructor.

Constructors

ListChannels'

Fields

privacy :: Maybe ChannelPrivacy
The privacy setting. PUBLIC retrieves all the public channels. PRIVATE retrieves private channels. Only an AppInstanceAdmin can retrieve private channels.
nextToken :: Maybe (Sensitive Text)
The token passed by previous API calls until all requested channels are returned.
maxResults :: Maybe Natural
The maximum number of channels that you want to return.
appInstanceArn :: Text
The ARN of the AppInstance.
chimeBearer :: Text
The AppInstanceUserArn of the user that makes the API call.

Instances

Instances details

Eq ListChannels Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannels Methods (==) :: ListChannels -> ListChannels -> Bool # (/=) :: ListChannels -> ListChannels -> Bool #
Show ListChannels Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannels Methods showsPrec :: Int -> ListChannels -> ShowS # show :: ListChannels -> String # showList :: [ListChannels] -> ShowS #
Generic ListChannels Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannels Associated Types type Rep ListChannels :: Type -> Type # Methods from :: ListChannels -> Rep ListChannels x # to :: Rep ListChannels x -> ListChannels #
NFData ListChannels Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannels Methods rnf :: ListChannels -> () #
Hashable ListChannels Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannels Methods hashWithSalt :: Int -> ListChannels -> Int # hash :: ListChannels -> Int #
AWSRequest ListChannels Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannels Associated Types type AWSResponse ListChannels # Methods request :: ListChannels -> Request ListChannels # response :: MonadResource m => Logger -> Service -> Proxy ListChannels -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListChannels))) #
ToHeaders ListChannels Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannels Methods toHeaders :: ListChannels -> [Header] #
ToPath ListChannels Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannels Methods toPath :: ListChannels -> ByteString #
ToQuery ListChannels Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannels Methods toQuery :: ListChannels -> QueryString #
type Rep ListChannels Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannels type Rep ListChannels = D1 ('MetaData "ListChannels" "Amazonka.ChimeSDKMessaging.ListChannels" "libZSservicesZSamazonka-chime-sdk-messagingZSamazonka-chime-sdk-messaging" 'False) (C1 ('MetaCons "ListChannels'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "privacy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChannelPrivacy)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text)))) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "appInstanceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "chimeBearer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse ListChannels Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannels type AWSResponse ListChannels = ListChannelsResponse

newListChannels Source #

Arguments

:: Text	`$sel:appInstanceArn:ListChannels'`
-> Text	`$sel:chimeBearer:ListChannels'`
-> ListChannels

Create a value of ListChannels 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:privacy:ListChannels', listChannels_privacy - The privacy setting. PUBLIC retrieves all the public channels. PRIVATE retrieves private channels. Only an AppInstanceAdmin can retrieve private channels.

$sel:nextToken:ListChannels', listChannels_nextToken - The token passed by previous API calls until all requested channels are returned.

$sel:maxResults:ListChannels', listChannels_maxResults - The maximum number of channels that you want to return.

$sel:appInstanceArn:ListChannels', listChannels_appInstanceArn - The ARN of the AppInstance.

$sel:chimeBearer:ListChannels', listChannels_chimeBearer - The AppInstanceUserArn of the user that makes the API call.

Request Lenses

listChannels_privacy :: Lens' ListChannels (Maybe ChannelPrivacy) Source #

The privacy setting. PUBLIC retrieves all the public channels. PRIVATE retrieves private channels. Only an AppInstanceAdmin can retrieve private channels.

listChannels_nextToken :: Lens' ListChannels (Maybe Text) Source #

The token passed by previous API calls until all requested channels are returned.

listChannels_maxResults :: Lens' ListChannels (Maybe Natural) Source #

The maximum number of channels that you want to return.

listChannels_appInstanceArn :: Lens' ListChannels Text Source #

The ARN of the AppInstance.

listChannels_chimeBearer :: Lens' ListChannels Text Source #

The AppInstanceUserArn of the user that makes the API call.

Destructuring the Response

data ListChannelsResponse Source #

See: newListChannelsResponse smart constructor.

Constructors

ListChannelsResponse'
Fields channels :: Maybe [ChannelSummary] The information about each channel. nextToken :: Maybe (Sensitive Text) The token returned from previous API requests until the number of channels is reached. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq ListChannelsResponse Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannels Methods (==) :: ListChannelsResponse -> ListChannelsResponse -> Bool # (/=) :: ListChannelsResponse -> ListChannelsResponse -> Bool #
Show ListChannelsResponse Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannels Methods showsPrec :: Int -> ListChannelsResponse -> ShowS # show :: ListChannelsResponse -> String # showList :: [ListChannelsResponse] -> ShowS #
Generic ListChannelsResponse Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannels Associated Types type Rep ListChannelsResponse :: Type -> Type # Methods from :: ListChannelsResponse -> Rep ListChannelsResponse x # to :: Rep ListChannelsResponse x -> ListChannelsResponse #
NFData ListChannelsResponse Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannels Methods rnf :: ListChannelsResponse -> () #
type Rep ListChannelsResponse Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannels type Rep ListChannelsResponse = D1 ('MetaData "ListChannelsResponse" "Amazonka.ChimeSDKMessaging.ListChannels" "libZSservicesZSamazonka-chime-sdk-messagingZSamazonka-chime-sdk-messaging" 'False) (C1 ('MetaCons "ListChannelsResponse'" '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))))

newListChannelsResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListChannelsResponse'`
-> ListChannelsResponse

Create a value of ListChannelsResponse 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:ListChannelsResponse', listChannelsResponse_channels - The information about each channel.

$sel:nextToken:ListChannels', listChannelsResponse_nextToken - The token returned from previous API requests until the number of channels is reached.

$sel:httpStatus:ListChannelsResponse', listChannelsResponse_httpStatus - The response's http status code.

Response Lenses

listChannelsResponse_channels :: Lens' ListChannelsResponse (Maybe [ChannelSummary]) Source #

The information about each channel.

listChannelsResponse_nextToken :: Lens' ListChannelsResponse (Maybe Text) Source #

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

listChannelsResponse_httpStatus :: Lens' ListChannelsResponse Int Source #

The response's http status code.