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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns the full details of a channel ban.

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 DescribeChannelBan Source #

See: newDescribeChannelBan smart constructor.

Constructors

DescribeChannelBan'
Fields channelArn :: Text The ARN of the channel from which the user is banned. memberArn :: Text The `AppInstanceUserArn` of the member being banned. chimeBearer :: Text The `AppInstanceUserArn` of the user that makes the API call.

Instances

Instances details

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

newDescribeChannelBan Source #

Arguments

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

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

DescribeChannelBan, describeChannelBan_channelArn - The ARN of the channel from which the user is banned.

DescribeChannelBan, describeChannelBan_memberArn - The AppInstanceUserArn of the member being banned.

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

Request Lenses

describeChannelBan_channelArn :: Lens' DescribeChannelBan Text Source #

The ARN of the channel from which the user is banned.

describeChannelBan_memberArn :: Lens' DescribeChannelBan Text Source #

The AppInstanceUserArn of the member being banned.

describeChannelBan_chimeBearer :: Lens' DescribeChannelBan Text Source #

The AppInstanceUserArn of the user that makes the API call.

Destructuring the Response

data DescribeChannelBanResponse Source #

See: newDescribeChannelBanResponse smart constructor.

Constructors

DescribeChannelBanResponse'
Fields channelBan :: Maybe ChannelBan The details of the ban. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newDescribeChannelBanResponse Source #

Arguments

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

Create a value of DescribeChannelBanResponse 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:channelBan:DescribeChannelBanResponse', describeChannelBanResponse_channelBan - The details of the ban.

$sel:httpStatus:DescribeChannelBanResponse', describeChannelBanResponse_httpStatus - The response's http status code.

Response Lenses

describeChannelBanResponse_channelBan :: Lens' DescribeChannelBanResponse (Maybe ChannelBan) Source #

The details of the ban.

describeChannelBanResponse_httpStatus :: Lens' DescribeChannelBanResponse Int Source #

The response's http status code.