Amazonka.ChimeSDKMessaging.ListChannelBans

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.

Creating a Request

data ListChannelBans

See: newListChannelBans smart constructor.

Constructors

ListChannelBans'

Fields

• maxResults :: Maybe Natural

  The maximum number of bans that you want returned.

• nextToken :: Maybe (Sensitive Text)

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

• channelArn :: Text

  The ARN of the channel.

• chimeBearer :: Text

  The AppInstanceUserArn of the user that makes the API call.

Instances

ToHeaders ListChannelBans

Defined in Amazonka.ChimeSDKMessaging.ListChannelBans

Methods

toHeaders :: ListChannelBans -> [Header]

ToPath ListChannelBans

Defined in Amazonka.ChimeSDKMessaging.ListChannelBans

Methods

toPath :: ListChannelBans -> ByteString

ToQuery ListChannelBans

Defined in Amazonka.ChimeSDKMessaging.ListChannelBans

Methods

toQuery :: ListChannelBans -> QueryString

AWSRequest ListChannelBans

Defined in Amazonka.ChimeSDKMessaging.ListChannelBans

Associated Types

type AWSResponse ListChannelBans

Methods

request :: (Service -> Service) -> ListChannelBans -> Request ListChannelBans

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListChannelBans -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListChannelBans)))

Generic ListChannelBans

Defined in Amazonka.ChimeSDKMessaging.ListChannelBans

Associated Types

type Rep ListChannelBans :: Type -> Type

Methods

from :: ListChannelBans -> Rep ListChannelBans x

to :: Rep ListChannelBans x -> ListChannelBans

Show ListChannelBans

Defined in Amazonka.ChimeSDKMessaging.ListChannelBans

Methods

showsPrec :: Int -> ListChannelBans -> ShowS

show :: ListChannelBans -> String

showList :: [ListChannelBans] -> ShowS

NFData ListChannelBans

Defined in Amazonka.ChimeSDKMessaging.ListChannelBans

Methods

rnf :: ListChannelBans -> ()

Eq ListChannelBans

Defined in Amazonka.ChimeSDKMessaging.ListChannelBans

Methods

(==) :: ListChannelBans -> ListChannelBans -> Bool

(/=) :: ListChannelBans -> ListChannelBans -> Bool

Hashable ListChannelBans

Defined in Amazonka.ChimeSDKMessaging.ListChannelBans

Methods

hashWithSalt :: Int -> ListChannelBans -> Int

hash :: ListChannelBans -> Int

type AWSResponse ListChannelBans

Defined in Amazonka.ChimeSDKMessaging.ListChannelBans

type AWSResponse ListChannelBans = ListChannelBansResponse

type Rep ListChannelBans

Defined in Amazonka.ChimeSDKMessaging.ListChannelBans

type Rep ListChannelBans = D1 ('MetaData "ListChannelBans" "Amazonka.ChimeSDKMessaging.ListChannelBans" "amazonka-chime-sdk-messaging-2.0-BxY1AbjLoDB4AQUv82PCQZ" 'False) (C1 ('MetaCons "ListChannelBans'" '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))))

newListChannelBans

Arguments

:: Text

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:maxResults:ListChannelBans', listChannelBans_maxResults - The maximum number of bans that you want returned.

ListChannelBans, listChannelBans_nextToken - The token passed by previous API calls until all requested bans are returned.

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_maxResults :: Lens' ListChannelBans (Maybe Natural)

The maximum number of bans that you want returned.

listChannelBans_nextToken :: Lens' ListChannelBans (Maybe Text)

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

listChannelBans_channelArn :: Lens' ListChannelBans Text

The ARN of the channel.

listChannelBans_chimeBearer :: Lens' ListChannelBans Text

The AppInstanceUserArn of the user that makes the API call.

Destructuring the Response

data ListChannelBansResponse

See: newListChannelBansResponse smart constructor.

Constructors

ListChannelBansResponse'

Fields

• channelArn :: Maybe Text

  The ARN of the channel.

• channelBans :: Maybe [ChannelBanSummary]

  The information for each requested ban.

• nextToken :: Maybe (Sensitive Text)

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

• httpStatus :: Int

  The response's http status code.

Instances

Generic ListChannelBansResponse

Defined in Amazonka.ChimeSDKMessaging.ListChannelBans

Associated Types

type Rep ListChannelBansResponse :: Type -> Type

Methods

from :: ListChannelBansResponse -> Rep ListChannelBansResponse x

to :: Rep ListChannelBansResponse x -> ListChannelBansResponse

Show ListChannelBansResponse

Defined in Amazonka.ChimeSDKMessaging.ListChannelBans

Methods

showsPrec :: Int -> ListChannelBansResponse -> ShowS

show :: ListChannelBansResponse -> String

showList :: [ListChannelBansResponse] -> ShowS

NFData ListChannelBansResponse

Defined in Amazonka.ChimeSDKMessaging.ListChannelBans

Methods

rnf :: ListChannelBansResponse -> ()

Eq ListChannelBansResponse

Defined in Amazonka.ChimeSDKMessaging.ListChannelBans

Methods

(==) :: ListChannelBansResponse -> ListChannelBansResponse -> Bool

(/=) :: ListChannelBansResponse -> ListChannelBansResponse -> Bool

type Rep ListChannelBansResponse

Defined in Amazonka.ChimeSDKMessaging.ListChannelBans

type Rep ListChannelBansResponse = D1 ('MetaData "ListChannelBansResponse" "Amazonka.ChimeSDKMessaging.ListChannelBans" "amazonka-chime-sdk-messaging-2.0-BxY1AbjLoDB4AQUv82PCQZ" 'False) (C1 ('MetaCons "ListChannelBansResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "channelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "channelBans") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ChannelBanSummary]))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListChannelBansResponse

Arguments

:: Int

$sel:httpStatus:ListChannelBansResponse'

-> ListChannelBansResponse

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:

ListChannelBans, listChannelBansResponse_channelArn - The ARN of the channel.

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

ListChannelBans, listChannelBansResponse_nextToken - The token passed by previous API calls until all requested bans are returned.

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

Response Lenses

listChannelBansResponse_channelArn :: Lens' ListChannelBansResponse (Maybe Text)

The ARN of the channel.

listChannelBansResponse_channelBans :: Lens' ListChannelBansResponse (Maybe [ChannelBanSummary])

The information for each requested ban.

listChannelBansResponse_nextToken :: Lens' ListChannelBansResponse (Maybe Text)

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

listChannelBansResponse_httpStatus :: Lens' ListChannelBansResponse Int

The response's http status code.