Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.ChimeSDKMessaging.ListSubChannels

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists all the SubChannels in an elastic channel when given a channel ID. Available only to the app instance admins and channel moderators of elastic channels.

Synopsis

data ListSubChannels = ListSubChannels' {
- maxResults :: Maybe Natural
- nextToken :: Maybe (Sensitive Text)
- channelArn :: Text
- chimeBearer :: Text
}
newListSubChannels :: Text -> Text -> ListSubChannels
listSubChannels_maxResults :: Lens' ListSubChannels (Maybe Natural)
listSubChannels_nextToken :: Lens' ListSubChannels (Maybe Text)
listSubChannels_channelArn :: Lens' ListSubChannels Text
listSubChannels_chimeBearer :: Lens' ListSubChannels Text
data ListSubChannelsResponse = ListSubChannelsResponse' {
- channelArn :: Maybe Text
- nextToken :: Maybe (Sensitive Text)
- subChannels :: Maybe [SubChannelSummary]
- httpStatus :: Int
}
newListSubChannelsResponse :: Int -> ListSubChannelsResponse
listSubChannelsResponse_channelArn :: Lens' ListSubChannelsResponse (Maybe Text)
listSubChannelsResponse_nextToken :: Lens' ListSubChannelsResponse (Maybe Text)
listSubChannelsResponse_subChannels :: Lens' ListSubChannelsResponse (Maybe [SubChannelSummary])
listSubChannelsResponse_httpStatus :: Lens' ListSubChannelsResponse Int

Creating a Request

data ListSubChannels Source #

See: newListSubChannels smart constructor.

Constructors

ListSubChannels'
Fields maxResults :: Maybe Natural The maximum number of sub-channels that you want to return. nextToken :: Maybe (Sensitive Text) The token passed by previous API calls until all requested sub-channels are returned. channelArn :: Text The ARN of elastic channel. chimeBearer :: Text The `AppInstanceUserArn` of the user making the API call.

Instances

Instances details

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

newListSubChannels Source #

Arguments

:: Text	`ListSubChannels`
-> Text	`$sel:chimeBearer:ListSubChannels'`
-> ListSubChannels

Create a value of ListSubChannels 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:maxResults:ListSubChannels', listSubChannels_maxResults - The maximum number of sub-channels that you want to return.

ListSubChannels, listSubChannels_nextToken - The token passed by previous API calls until all requested sub-channels are returned.

ListSubChannels, listSubChannels_channelArn - The ARN of elastic channel.

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

Request Lenses

listSubChannels_maxResults :: Lens' ListSubChannels (Maybe Natural) Source #

The maximum number of sub-channels that you want to return.

listSubChannels_nextToken :: Lens' ListSubChannels (Maybe Text) Source #

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

listSubChannels_channelArn :: Lens' ListSubChannels Text Source #

The ARN of elastic channel.

listSubChannels_chimeBearer :: Lens' ListSubChannels Text Source #

The AppInstanceUserArn of the user making the API call.

Destructuring the Response

data ListSubChannelsResponse Source #

See: newListSubChannelsResponse smart constructor.

Constructors

ListSubChannelsResponse'
Fields channelArn :: Maybe Text The ARN of elastic channel. nextToken :: Maybe (Sensitive Text) The token passed by previous API calls until all requested sub-channels are returned. subChannels :: Maybe [SubChannelSummary] The information about each sub-channel. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ListSubChannelsResponse Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListSubChannels Associated Types type Rep ListSubChannelsResponse :: Type -> Type # Methods from :: ListSubChannelsResponse -> Rep ListSubChannelsResponse x # to :: Rep ListSubChannelsResponse x -> ListSubChannelsResponse #
Show ListSubChannelsResponse Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListSubChannels Methods showsPrec :: Int -> ListSubChannelsResponse -> ShowS # show :: ListSubChannelsResponse -> String # showList :: [ListSubChannelsResponse] -> ShowS #
NFData ListSubChannelsResponse Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListSubChannels Methods rnf :: ListSubChannelsResponse -> () #
Eq ListSubChannelsResponse Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListSubChannels Methods (==) :: ListSubChannelsResponse -> ListSubChannelsResponse -> Bool # (/=) :: ListSubChannelsResponse -> ListSubChannelsResponse -> Bool #
type Rep ListSubChannelsResponse Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListSubChannels type Rep ListSubChannelsResponse = D1 ('MetaData "ListSubChannelsResponse" "Amazonka.ChimeSDKMessaging.ListSubChannels" "amazonka-chime-sdk-messaging-2.0-BxY1AbjLoDB4AQUv82PCQZ" 'False) (C1 ('MetaCons "ListSubChannelsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "channelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text)))) :: (S1 ('MetaSel ('Just "subChannels") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SubChannelSummary])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListSubChannelsResponse Source #

Arguments

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

Create a value of ListSubChannelsResponse 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:

ListSubChannels, listSubChannelsResponse_channelArn - The ARN of elastic channel.

ListSubChannels, listSubChannelsResponse_nextToken - The token passed by previous API calls until all requested sub-channels are returned.

$sel:subChannels:ListSubChannelsResponse', listSubChannelsResponse_subChannels - The information about each sub-channel.

$sel:httpStatus:ListSubChannelsResponse', listSubChannelsResponse_httpStatus - The response's http status code.

Response Lenses

listSubChannelsResponse_channelArn :: Lens' ListSubChannelsResponse (Maybe Text) Source #

The ARN of elastic channel.

listSubChannelsResponse_nextToken :: Lens' ListSubChannelsResponse (Maybe Text) Source #

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

listSubChannelsResponse_subChannels :: Lens' ListSubChannelsResponse (Maybe [SubChannelSummary]) Source #

The information about each sub-channel.

listSubChannelsResponse_httpStatus :: Lens' ListSubChannelsResponse Int Source #

The response's http status code.