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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists all the users banned from a particular 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 ListChannelBans = ListChannelBans' {
- nextToken :: Maybe (Sensitive Text)
- maxResults :: Maybe Natural
- channelArn :: Text
- chimeBearer :: Text
}
newListChannelBans :: Text -> Text -> ListChannelBans
listChannelBans_nextToken :: Lens' ListChannelBans (Maybe Text)
listChannelBans_maxResults :: Lens' ListChannelBans (Maybe Natural)
listChannelBans_channelArn :: Lens' ListChannelBans Text
listChannelBans_chimeBearer :: Lens' ListChannelBans Text
data ListChannelBansResponse = ListChannelBansResponse' {
- channelArn :: Maybe Text
- nextToken :: Maybe (Sensitive Text)
- channelBans :: Maybe [ChannelBanSummary]
- httpStatus :: Int
}
newListChannelBansResponse :: Int -> ListChannelBansResponse
listChannelBansResponse_channelArn :: Lens' ListChannelBansResponse (Maybe Text)
listChannelBansResponse_nextToken :: Lens' ListChannelBansResponse (Maybe Text)
listChannelBansResponse_channelBans :: Lens' ListChannelBansResponse (Maybe [ChannelBanSummary])
listChannelBansResponse_httpStatus :: Lens' ListChannelBansResponse Int

Creating a Request

data ListChannelBans Source #

See: newListChannelBans smart constructor.

Constructors

ListChannelBans'
Fields nextToken :: Maybe (Sensitive Text) The token passed by previous API calls until all requested bans are returned. maxResults :: Maybe Natural The maximum number of bans 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 ListChannelBans Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannelBans Methods (==) :: ListChannelBans -> ListChannelBans -> Bool # (/=) :: ListChannelBans -> ListChannelBans -> Bool #
Show ListChannelBans Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannelBans Methods showsPrec :: Int -> ListChannelBans -> ShowS # show :: ListChannelBans -> String # showList :: [ListChannelBans] -> ShowS #
Generic ListChannelBans Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannelBans Associated Types type Rep ListChannelBans :: Type -> Type # Methods from :: ListChannelBans -> Rep ListChannelBans x # to :: Rep ListChannelBans x -> ListChannelBans #
NFData ListChannelBans Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannelBans Methods rnf :: ListChannelBans -> () #
Hashable ListChannelBans Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannelBans Methods hashWithSalt :: Int -> ListChannelBans -> Int # hash :: ListChannelBans -> Int #
AWSRequest ListChannelBans Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannelBans Associated Types type AWSResponse ListChannelBans # Methods request :: ListChannelBans -> Request ListChannelBans # response :: MonadResource m => Logger -> Service -> Proxy ListChannelBans -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListChannelBans))) #
ToHeaders ListChannelBans Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannelBans Methods toHeaders :: ListChannelBans -> [Header] #
ToPath ListChannelBans Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannelBans Methods toPath :: ListChannelBans -> ByteString #
ToQuery ListChannelBans Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannelBans Methods toQuery :: ListChannelBans -> QueryString #
type Rep ListChannelBans Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannelBans type Rep ListChannelBans = D1 ('MetaData "ListChannelBans" "Amazonka.ChimeSDKMessaging.ListChannelBans" "libZSservicesZSamazonka-chime-sdk-messagingZSamazonka-chime-sdk-messaging" 'False) (C1 ('MetaCons "ListChannelBans'" '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 ListChannelBans Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.ListChannelBans type AWSResponse ListChannelBans = ListChannelBansResponse

newListChannelBans Source #

Arguments

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

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

$sel:maxResults:ListChannelBans', listChannelBans_maxResults - The maximum number of bans that you want returned.

$sel:channelArn:ListChannelBans', listChannelBans_channelArn - The ARN of the channel.

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

Request Lenses

listChannelBans_nextToken :: Lens' ListChannelBans (Maybe Text) Source #

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

listChannelBans_maxResults :: Lens' ListChannelBans (Maybe Natural) Source #

The maximum number of bans that you want returned.

listChannelBans_channelArn :: Lens' ListChannelBans Text Source #

The ARN of the channel.

listChannelBans_chimeBearer :: Lens' ListChannelBans Text Source #

The AppInstanceUserArn of the user that makes the API call.

Destructuring the Response

data ListChannelBansResponse Source #

See: newListChannelBansResponse smart constructor.

Constructors

ListChannelBansResponse'
Fields channelArn :: Maybe Text The ARN of the channel. nextToken :: Maybe (Sensitive Text) The token passed by previous API calls until all requested bans are returned. channelBans :: Maybe [ChannelBanSummary] The information for each requested ban. httpStatus :: Int The response's http status code.

Instances

Instances details

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