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.Chime.CreateChannelMembership

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Adds a user to a channel. The InvitedBy response field is derived from the request header. A channel member can:

List messages
Send messages
Receive messages
Edit their own messages
Leave the channel

Privacy settings impact this action as follows:

Public Channels: You do not need to be a member to list messages, but you must be a member to send messages.
Private Channels: You must be a member to list or send messages.

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

See: newCreateChannelMembership smart constructor.

Constructors

CreateChannelMembership'

Fields

chimeBearer :: Maybe Text
The AppInstanceUserArn of the user that makes the API call.
channelArn :: Text
The ARN of the channel to which you're adding users.
memberArn :: Text
The ARN of the member you want to add to the channel.
type' :: ChannelMembershipType
The membership type of a user, DEFAULT or HIDDEN. Default members are always returned as part of ListChannelMemberships. Hidden members are only returned if the type filter in ListChannelMemberships equals HIDDEN. Otherwise hidden members are not returned. This is only supported by moderators.

Instances

Instances details

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

newCreateChannelMembership Source #

Arguments

:: Text	`CreateChannelMembership`
-> Text	`CreateChannelMembership`
-> ChannelMembershipType	`CreateChannelMembership`
-> CreateChannelMembership

Create a value of CreateChannelMembership 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:chimeBearer:CreateChannelMembership', createChannelMembership_chimeBearer - The AppInstanceUserArn of the user that makes the API call.

CreateChannelMembership, createChannelMembership_channelArn - The ARN of the channel to which you're adding users.

CreateChannelMembership, createChannelMembership_memberArn - The ARN of the member you want to add to the channel.

CreateChannelMembership, createChannelMembership_type - The membership type of a user, DEFAULT or HIDDEN. Default members are always returned as part of ListChannelMemberships. Hidden members are only returned if the type filter in ListChannelMemberships equals HIDDEN. Otherwise hidden members are not returned. This is only supported by moderators.

Request Lenses

createChannelMembership_chimeBearer :: Lens' CreateChannelMembership (Maybe Text) Source #

The AppInstanceUserArn of the user that makes the API call.

createChannelMembership_channelArn :: Lens' CreateChannelMembership Text Source #

The ARN of the channel to which you're adding users.

createChannelMembership_memberArn :: Lens' CreateChannelMembership Text Source #

The ARN of the member you want to add to the channel.

createChannelMembership_type :: Lens' CreateChannelMembership ChannelMembershipType Source #

The membership type of a user, DEFAULT or HIDDEN. Default members are always returned as part of ListChannelMemberships. Hidden members are only returned if the type filter in ListChannelMemberships equals HIDDEN. Otherwise hidden members are not returned. This is only supported by moderators.

Destructuring the Response

data CreateChannelMembershipResponse Source #

See: newCreateChannelMembershipResponse smart constructor.

Constructors

CreateChannelMembershipResponse'
Fields channelArn :: Maybe Text The ARN of the channel. member :: Maybe Identity The ARN and metadata of the member being added. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateChannelMembershipResponse Source #
Instance details Defined in Amazonka.Chime.CreateChannelMembership Associated Types type Rep CreateChannelMembershipResponse :: Type -> Type # Methods from :: CreateChannelMembershipResponse -> Rep CreateChannelMembershipResponse x # to :: Rep CreateChannelMembershipResponse x -> CreateChannelMembershipResponse #
Show CreateChannelMembershipResponse Source #
Instance details Defined in Amazonka.Chime.CreateChannelMembership Methods showsPrec :: Int -> CreateChannelMembershipResponse -> ShowS # show :: CreateChannelMembershipResponse -> String # showList :: [CreateChannelMembershipResponse] -> ShowS #
NFData CreateChannelMembershipResponse Source #
Instance details Defined in Amazonka.Chime.CreateChannelMembership Methods rnf :: CreateChannelMembershipResponse -> () #
Eq CreateChannelMembershipResponse Source #
Instance details Defined in Amazonka.Chime.CreateChannelMembership Methods (==) :: CreateChannelMembershipResponse -> CreateChannelMembershipResponse -> Bool # (/=) :: CreateChannelMembershipResponse -> CreateChannelMembershipResponse -> Bool #
type Rep CreateChannelMembershipResponse Source #
Instance details Defined in Amazonka.Chime.CreateChannelMembership type Rep CreateChannelMembershipResponse = D1 ('MetaData "CreateChannelMembershipResponse" "Amazonka.Chime.CreateChannelMembership" "amazonka-chime-2.0-AQIuSSkHccQ9VXokPBc5Nb" 'False) (C1 ('MetaCons "CreateChannelMembershipResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "channelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "member") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Identity)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateChannelMembershipResponse Source #

Arguments

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

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

CreateChannelMembership, createChannelMembershipResponse_channelArn - The ARN of the channel.

CreateChannelMembershipResponse, createChannelMembershipResponse_member - The ARN and metadata of the member being added.

$sel:httpStatus:CreateChannelMembershipResponse', createChannelMembershipResponse_httpStatus - The response's http status code.

Response Lenses

createChannelMembershipResponse_channelArn :: Lens' CreateChannelMembershipResponse (Maybe Text) Source #

The ARN of the channel.

createChannelMembershipResponse_member :: Lens' CreateChannelMembershipResponse (Maybe Identity) Source #

The ARN and metadata of the member being added.

createChannelMembershipResponse_httpStatus :: Lens' CreateChannelMembershipResponse Int Source #

The response's http status code.