Amazonka.ChimeSDKMessaging.CreateChannelMembership

Adds a user to a channel. The InvitedBy field in ChannelMembership 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.

Creating a Request

data CreateChannelMembership

See: newCreateChannelMembership smart constructor.

Constructors

CreateChannelMembership'

Fields

• subChannelId :: Maybe Text

  The ID of the SubChannel in the request.

  Only required when creating membership in a SubChannel for a moderator in an elastic channel.

• channelArn :: Text

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

• memberArn :: Text

  The AppInstanceUserArn 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.

• chimeBearer :: Text

  The AppInstanceUserArn of the user that makes the API call.

Instances

ToJSON CreateChannelMembership

Defined in Amazonka.ChimeSDKMessaging.CreateChannelMembership

Methods

toJSON :: CreateChannelMembership -> Value

toEncoding :: CreateChannelMembership -> Encoding

toJSONList :: [CreateChannelMembership] -> Value

toEncodingList :: [CreateChannelMembership] -> Encoding

ToHeaders CreateChannelMembership

Defined in Amazonka.ChimeSDKMessaging.CreateChannelMembership

Methods

toHeaders :: CreateChannelMembership -> [Header]

ToPath CreateChannelMembership

Defined in Amazonka.ChimeSDKMessaging.CreateChannelMembership

Methods

toPath :: CreateChannelMembership -> ByteString

ToQuery CreateChannelMembership

Defined in Amazonka.ChimeSDKMessaging.CreateChannelMembership

Methods

toQuery :: CreateChannelMembership -> QueryString

AWSRequest CreateChannelMembership

Defined in Amazonka.ChimeSDKMessaging.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

Defined in Amazonka.ChimeSDKMessaging.CreateChannelMembership

Associated Types

type Rep CreateChannelMembership :: Type -> Type

Methods

from :: CreateChannelMembership -> Rep CreateChannelMembership x

to :: Rep CreateChannelMembership x -> CreateChannelMembership

Read CreateChannelMembership

Defined in Amazonka.ChimeSDKMessaging.CreateChannelMembership

Methods

readsPrec :: Int -> ReadS CreateChannelMembership

readList :: ReadS [CreateChannelMembership]

readPrec :: ReadPrec CreateChannelMembership

readListPrec :: ReadPrec [CreateChannelMembership]

Show CreateChannelMembership

Defined in Amazonka.ChimeSDKMessaging.CreateChannelMembership

Methods

showsPrec :: Int -> CreateChannelMembership -> ShowS

show :: CreateChannelMembership -> String

showList :: [CreateChannelMembership] -> ShowS

NFData CreateChannelMembership

Defined in Amazonka.ChimeSDKMessaging.CreateChannelMembership

Methods

rnf :: CreateChannelMembership -> ()

Eq CreateChannelMembership

Defined in Amazonka.ChimeSDKMessaging.CreateChannelMembership

Methods

(==) :: CreateChannelMembership -> CreateChannelMembership -> Bool

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

Hashable CreateChannelMembership

Defined in Amazonka.ChimeSDKMessaging.CreateChannelMembership

Methods

hashWithSalt :: Int -> CreateChannelMembership -> Int

hash :: CreateChannelMembership -> Int

type AWSResponse CreateChannelMembership

Defined in Amazonka.ChimeSDKMessaging.CreateChannelMembership

type AWSResponse CreateChannelMembership = CreateChannelMembershipResponse

type Rep CreateChannelMembership

Defined in Amazonka.ChimeSDKMessaging.CreateChannelMembership

type Rep CreateChannelMembership = D1 ('MetaData "CreateChannelMembership" "Amazonka.ChimeSDKMessaging.CreateChannelMembership" "amazonka-chime-sdk-messaging-2.0-BxY1AbjLoDB4AQUv82PCQZ" 'False) (C1 ('MetaCons "CreateChannelMembership'" '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 "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ChannelMembershipType) :*: S1 ('MetaSel ('Just "chimeBearer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateChannelMembership

Arguments

:: Text

CreateChannelMembership

-> Text

CreateChannelMembership

-> ChannelMembershipType

CreateChannelMembership

-> Text

$sel:chimeBearer: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:

CreateChannelMembership, createChannelMembership_subChannelId - The ID of the SubChannel in the request.

Only required when creating membership in a SubChannel for a moderator in an elastic channel.

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

CreateChannelMembership, createChannelMembership_memberArn - The AppInstanceUserArn 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.

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

Request Lenses

createChannelMembership_subChannelId :: Lens' CreateChannelMembership (Maybe Text)

The ID of the SubChannel in the request.

Only required when creating membership in a SubChannel for a moderator in an elastic channel.

createChannelMembership_channelArn :: Lens' CreateChannelMembership Text

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

createChannelMembership_memberArn :: Lens' CreateChannelMembership Text

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

createChannelMembership_type :: Lens' CreateChannelMembership 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.

createChannelMembership_chimeBearer :: Lens' CreateChannelMembership Text

The AppInstanceUserArn of the user that makes the API call.

Destructuring the Response

data CreateChannelMembershipResponse

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.

• subChannelId :: Maybe Text

  The ID of the SubChannel in the response.

• httpStatus :: Int

  The response's http status code.

Instances

Generic CreateChannelMembershipResponse

Defined in Amazonka.ChimeSDKMessaging.CreateChannelMembership

Associated Types

type Rep CreateChannelMembershipResponse :: Type -> Type

Methods

from :: CreateChannelMembershipResponse -> Rep CreateChannelMembershipResponse x

to :: Rep CreateChannelMembershipResponse x -> CreateChannelMembershipResponse

Show CreateChannelMembershipResponse

Defined in Amazonka.ChimeSDKMessaging.CreateChannelMembership

Methods

showsPrec :: Int -> CreateChannelMembershipResponse -> ShowS

show :: CreateChannelMembershipResponse -> String

showList :: [CreateChannelMembershipResponse] -> ShowS

NFData CreateChannelMembershipResponse

Defined in Amazonka.ChimeSDKMessaging.CreateChannelMembership

Methods

rnf :: CreateChannelMembershipResponse -> ()

Eq CreateChannelMembershipResponse

Defined in Amazonka.ChimeSDKMessaging.CreateChannelMembership

Methods

(==) :: CreateChannelMembershipResponse -> CreateChannelMembershipResponse -> Bool

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

type Rep CreateChannelMembershipResponse

Defined in Amazonka.ChimeSDKMessaging.CreateChannelMembership

type Rep CreateChannelMembershipResponse = D1 ('MetaData "CreateChannelMembershipResponse" "Amazonka.ChimeSDKMessaging.CreateChannelMembership" "amazonka-chime-sdk-messaging-2.0-BxY1AbjLoDB4AQUv82PCQZ" '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 "subChannelId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateChannelMembershipResponse

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.

CreateChannelMembership, createChannelMembershipResponse_subChannelId - The ID of the SubChannel in the response.

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

Response Lenses

createChannelMembershipResponse_channelArn :: Lens' CreateChannelMembershipResponse (Maybe Text)

The ARN of the channel.

createChannelMembershipResponse_member :: Lens' CreateChannelMembershipResponse (Maybe Identity)

The ARN and metadata of the member being added.

createChannelMembershipResponse_subChannelId :: Lens' CreateChannelMembershipResponse (Maybe Text)

The ID of the SubChannel in the response.

createChannelMembershipResponse_httpStatus :: Lens' CreateChannelMembershipResponse Int

The response's http status code.