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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns the full details of a channel in an Amazon Chime AppInstance.

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

See: newDescribeChannel smart constructor.

Constructors

DescribeChannel'
Fields channelArn :: Text The ARN of the channel. chimeBearer :: Text The `AppInstanceUserArn` of the user that makes the API call.

Instances

Instances details

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

newDescribeChannel Source #

Arguments

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

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

DescribeChannel, describeChannel_channelArn - The ARN of the channel.

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

Request Lenses

describeChannel_channelArn :: Lens' DescribeChannel Text Source #

The ARN of the channel.

describeChannel_chimeBearer :: Lens' DescribeChannel Text Source #

The AppInstanceUserArn of the user that makes the API call.

Destructuring the Response

data DescribeChannelResponse Source #

See: newDescribeChannelResponse smart constructor.

Constructors

DescribeChannelResponse'
Fields channel :: Maybe Channel The channel details. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newDescribeChannelResponse Source #

Arguments

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

Create a value of DescribeChannelResponse 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:channel:DescribeChannelResponse', describeChannelResponse_channel - The channel details.

$sel:httpStatus:DescribeChannelResponse', describeChannelResponse_httpStatus - The response's http status code.

Response Lenses

describeChannelResponse_channel :: Lens' DescribeChannelResponse (Maybe Channel) Source #

The channel details.

describeChannelResponse_httpStatus :: Lens' DescribeChannelResponse Int Source #

The response's http status code.