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.ListChannelModerators

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists all the moderators for a channel.

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 ListChannelModerators = ListChannelModerators' {
- nextToken :: Maybe (Sensitive Text)
- maxResults :: Maybe Natural
- channelArn :: Text
- chimeBearer :: Text
}
newListChannelModerators :: Text -> Text -> ListChannelModerators
listChannelModerators_nextToken :: Lens' ListChannelModerators (Maybe Text)
listChannelModerators_maxResults :: Lens' ListChannelModerators (Maybe Natural)
listChannelModerators_channelArn :: Lens' ListChannelModerators Text
listChannelModerators_chimeBearer :: Lens' ListChannelModerators Text
data ListChannelModeratorsResponse = ListChannelModeratorsResponse' {
- channelArn :: Maybe Text
- nextToken :: Maybe (Sensitive Text)
- channelModerators :: Maybe [ChannelModeratorSummary]
- httpStatus :: Int
}
newListChannelModeratorsResponse :: Int -> ListChannelModeratorsResponse
listChannelModeratorsResponse_channelArn :: Lens' ListChannelModeratorsResponse (Maybe Text)
listChannelModeratorsResponse_nextToken :: Lens' ListChannelModeratorsResponse (Maybe Text)
listChannelModeratorsResponse_channelModerators :: Lens' ListChannelModeratorsResponse (Maybe [ChannelModeratorSummary])
listChannelModeratorsResponse_httpStatus :: Lens' ListChannelModeratorsResponse Int

Creating a Request

data ListChannelModerators Source #

See: newListChannelModerators smart constructor.

Constructors

ListChannelModerators'
Fields nextToken :: Maybe (Sensitive Text) The token passed by previous API calls until all requested moderators are returned. maxResults :: Maybe Natural The maximum number of moderators that you want returned. channelArn :: Text The ARN of the channel. chimeBearer :: Text The `AppInstanceUserArn` of the user that makes the API call.

Instances

Instances details

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

newListChannelModerators Source #

Arguments

:: Text	`$sel:channelArn:ListChannelModerators'`
-> Text	`$sel:chimeBearer:ListChannelModerators'`
-> ListChannelModerators

Create a value of ListChannelModerators 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:nextToken:ListChannelModerators', listChannelModerators_nextToken - The token passed by previous API calls until all requested moderators are returned.

$sel:maxResults:ListChannelModerators', listChannelModerators_maxResults - The maximum number of moderators that you want returned.

$sel:channelArn:ListChannelModerators', listChannelModerators_channelArn - The ARN of the channel.

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

Request Lenses

listChannelModerators_nextToken :: Lens' ListChannelModerators (Maybe Text) Source #

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

listChannelModerators_maxResults :: Lens' ListChannelModerators (Maybe Natural) Source #

The maximum number of moderators that you want returned.

listChannelModerators_channelArn :: Lens' ListChannelModerators Text Source #

The ARN of the channel.

listChannelModerators_chimeBearer :: Lens' ListChannelModerators Text Source #

The AppInstanceUserArn of the user that makes the API call.

Destructuring the Response

data ListChannelModeratorsResponse Source #

See: newListChannelModeratorsResponse smart constructor.

Constructors

ListChannelModeratorsResponse'
Fields channelArn :: Maybe Text The ARN of the channel. nextToken :: Maybe (Sensitive Text) The token passed by previous API calls until all requested moderators are returned. channelModerators :: Maybe [ChannelModeratorSummary] The information about and names of each moderator. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq ListChannelModeratorsResponse Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannelModerators Methods (==) :: ListChannelModeratorsResponse -> ListChannelModeratorsResponse -> Bool # (/=) :: ListChannelModeratorsResponse -> ListChannelModeratorsResponse -> Bool #
Show ListChannelModeratorsResponse Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannelModerators Methods showsPrec :: Int -> ListChannelModeratorsResponse -> ShowS # show :: ListChannelModeratorsResponse -> String # showList :: [ListChannelModeratorsResponse] -> ShowS #
Generic ListChannelModeratorsResponse Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannelModerators Associated Types type Rep ListChannelModeratorsResponse :: Type -> Type # Methods from :: ListChannelModeratorsResponse -> Rep ListChannelModeratorsResponse x # to :: Rep ListChannelModeratorsResponse x -> ListChannelModeratorsResponse #
NFData ListChannelModeratorsResponse Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannelModerators Methods rnf :: ListChannelModeratorsResponse -> () #
type Rep ListChannelModeratorsResponse Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannelModerators type Rep ListChannelModeratorsResponse = D1 ('MetaData "ListChannelModeratorsResponse" "Amazonka.ChimeSDKMessaging.ListChannelModerators" "libZSservicesZSamazonka-chime-sdk-messagingZSamazonka-chime-sdk-messaging" 'False) (C1 ('MetaCons "ListChannelModeratorsResponse'" '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 "channelModerators") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ChannelModeratorSummary])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListChannelModeratorsResponse Source #

Arguments

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

Create a value of ListChannelModeratorsResponse 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:channelArn:ListChannelModerators', listChannelModeratorsResponse_channelArn - The ARN of the channel.

$sel:nextToken:ListChannelModerators', listChannelModeratorsResponse_nextToken - The token passed by previous API calls until all requested moderators are returned.

$sel:channelModerators:ListChannelModeratorsResponse', listChannelModeratorsResponse_channelModerators - The information about and names of each moderator.

$sel:httpStatus:ListChannelModeratorsResponse', listChannelModeratorsResponse_httpStatus - The response's http status code.

Response Lenses

listChannelModeratorsResponse_channelArn :: Lens' ListChannelModeratorsResponse (Maybe Text) Source #

The ARN of the channel.

listChannelModeratorsResponse_nextToken :: Lens' ListChannelModeratorsResponse (Maybe Text) Source #

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

listChannelModeratorsResponse_channelModerators :: Lens' ListChannelModeratorsResponse (Maybe [ChannelModeratorSummary]) Source #

The information about and names of each moderator.

listChannelModeratorsResponse_httpStatus :: Lens' ListChannelModeratorsResponse Int Source #

The response's http status code.