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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns the full details of a user's channel membership.

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

See: newDescribeChannelMembership smart constructor.

Constructors

DescribeChannelMembership'
Fields subChannelId :: Maybe Text The ID of the SubChannel in the request. The response contains an `ElasticChannelConfiguration` object. Only required to get a user’s SubChannel membership details. channelArn :: Text The ARN of the channel. memberArn :: Text The `AppInstanceUserArn` of the member. chimeBearer :: Text The `AppInstanceUserArn` of the user that makes the API call.

Instances

Instances details

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

newDescribeChannelMembership Source #

Arguments

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

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

DescribeChannelMembership, describeChannelMembership_subChannelId - The ID of the SubChannel in the request. The response contains an ElasticChannelConfiguration object.

Only required to get a user’s SubChannel membership details.

DescribeChannelMembership, describeChannelMembership_channelArn - The ARN of the channel.

DescribeChannelMembership, describeChannelMembership_memberArn - The AppInstanceUserArn of the member.

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

Request Lenses

describeChannelMembership_subChannelId :: Lens' DescribeChannelMembership (Maybe Text) Source #

The ID of the SubChannel in the request. The response contains an ElasticChannelConfiguration object.

Only required to get a user’s SubChannel membership details.

describeChannelMembership_channelArn :: Lens' DescribeChannelMembership Text Source #

The ARN of the channel.

describeChannelMembership_memberArn :: Lens' DescribeChannelMembership Text Source #

The AppInstanceUserArn of the member.

describeChannelMembership_chimeBearer :: Lens' DescribeChannelMembership Text Source #

The AppInstanceUserArn of the user that makes the API call.

Destructuring the Response

data DescribeChannelMembershipResponse Source #

See: newDescribeChannelMembershipResponse smart constructor.

Constructors

DescribeChannelMembershipResponse'
Fields channelMembership :: Maybe ChannelMembership The details of the membership. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newDescribeChannelMembershipResponse Source #

Arguments

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

Create a value of DescribeChannelMembershipResponse 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:channelMembership:DescribeChannelMembershipResponse', describeChannelMembershipResponse_channelMembership - The details of the membership.

$sel:httpStatus:DescribeChannelMembershipResponse', describeChannelMembershipResponse_httpStatus - The response's http status code.

Response Lenses

describeChannelMembershipResponse_channelMembership :: Lens' DescribeChannelMembershipResponse (Maybe ChannelMembership) Source #

The details of the membership.

describeChannelMembershipResponse_httpStatus :: Lens' DescribeChannelMembershipResponse Int Source #

The response's http status code.