libZSservicesZSamazonka-chime-sdk-messagingZSamazonka-chime-sdk-messaging
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.ChimeSDKMessaging.ListChannelBans

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

Creating a Request

data ListChannelBans Source #

See: newListChannelBans smart constructor.

Constructors

ListChannelBans' 

Fields

Instances

Instances details
Eq ListChannelBans Source # 
Instance details

Defined in Amazonka.ChimeSDKMessaging.ListChannelBans

Show ListChannelBans Source # 
Instance details

Defined in Amazonka.ChimeSDKMessaging.ListChannelBans

Generic ListChannelBans Source # 
Instance details

Defined in Amazonka.ChimeSDKMessaging.ListChannelBans

Associated Types

type Rep ListChannelBans :: Type -> Type #

NFData ListChannelBans Source # 
Instance details

Defined in Amazonka.ChimeSDKMessaging.ListChannelBans

Methods

rnf :: ListChannelBans -> () #

Hashable ListChannelBans Source # 
Instance details

Defined in Amazonka.ChimeSDKMessaging.ListChannelBans

AWSRequest ListChannelBans Source # 
Instance details

Defined in Amazonka.ChimeSDKMessaging.ListChannelBans

Associated Types

type AWSResponse ListChannelBans #

ToHeaders ListChannelBans Source # 
Instance details

Defined in Amazonka.ChimeSDKMessaging.ListChannelBans

ToPath ListChannelBans Source # 
Instance details

Defined in Amazonka.ChimeSDKMessaging.ListChannelBans

ToQuery ListChannelBans Source # 
Instance details

Defined in Amazonka.ChimeSDKMessaging.ListChannelBans

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

newListChannelBans Source #

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_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

Instances

Instances details
Eq ListChannelBansResponse Source # 
Instance details

Defined in Amazonka.ChimeSDKMessaging.ListChannelBans

Show ListChannelBansResponse Source # 
Instance details

Defined in Amazonka.ChimeSDKMessaging.ListChannelBans

Generic ListChannelBansResponse Source # 
Instance details

Defined in Amazonka.ChimeSDKMessaging.ListChannelBans

Associated Types

type Rep ListChannelBansResponse :: Type -> Type #

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))))

newListChannelBansResponse Source #

Create a value of ListChannelBansResponse 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:ListChannelBans', listChannelBansResponse_channelArn - The ARN of the channel.

$sel:nextToken:ListChannelBans', listChannelBansResponse_nextToken - The token passed by previous API calls until all requested bans are returned.

$sel:channelBans:ListChannelBansResponse', listChannelBansResponse_channelBans - The information for each requested ban.

$sel:httpStatus:ListChannelBansResponse', listChannelBansResponse_httpStatus - The response's http status code.

Response Lenses

listChannelBansResponse_nextToken :: Lens' ListChannelBansResponse (Maybe Text) Source #

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