| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.ChimeSDKMessaging.BatchCreateChannelMembership
Description
Adds a specified number of users to a channel.
Synopsis
- data BatchCreateChannelMembership = BatchCreateChannelMembership' {}
- newBatchCreateChannelMembership :: Text -> NonEmpty Text -> Text -> BatchCreateChannelMembership
- batchCreateChannelMembership_type :: Lens' BatchCreateChannelMembership (Maybe ChannelMembershipType)
- batchCreateChannelMembership_channelArn :: Lens' BatchCreateChannelMembership Text
- batchCreateChannelMembership_memberArns :: Lens' BatchCreateChannelMembership (NonEmpty Text)
- batchCreateChannelMembership_chimeBearer :: Lens' BatchCreateChannelMembership Text
- data BatchCreateChannelMembershipResponse = BatchCreateChannelMembershipResponse' {}
- newBatchCreateChannelMembershipResponse :: Int -> BatchCreateChannelMembershipResponse
- batchCreateChannelMembershipResponse_errors :: Lens' BatchCreateChannelMembershipResponse (Maybe [BatchCreateChannelMembershipError])
- batchCreateChannelMembershipResponse_batchChannelMemberships :: Lens' BatchCreateChannelMembershipResponse (Maybe BatchChannelMemberships)
- batchCreateChannelMembershipResponse_httpStatus :: Lens' BatchCreateChannelMembershipResponse Int
Creating a Request
data BatchCreateChannelMembership Source #
See: newBatchCreateChannelMembership smart constructor.
Constructors
| BatchCreateChannelMembership' | |
Fields
| |
Instances
newBatchCreateChannelMembership Source #
Arguments
| :: Text | |
| -> NonEmpty Text | |
| -> Text | |
| -> BatchCreateChannelMembership |
Create a value of BatchCreateChannelMembership 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:type':BatchCreateChannelMembership', batchCreateChannelMembership_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:channelArn:BatchCreateChannelMembership', batchCreateChannelMembership_channelArn - The ARN of the channel to which you're adding users.
$sel:memberArns:BatchCreateChannelMembership', batchCreateChannelMembership_memberArns - The ARNs of the members you want to add to the channel.
$sel:chimeBearer:BatchCreateChannelMembership', batchCreateChannelMembership_chimeBearer - The AppInstanceUserArn of the user that makes the API call.
Request Lenses
batchCreateChannelMembership_type :: Lens' BatchCreateChannelMembership (Maybe 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.
batchCreateChannelMembership_channelArn :: Lens' BatchCreateChannelMembership Text Source #
The ARN of the channel to which you're adding users.
batchCreateChannelMembership_memberArns :: Lens' BatchCreateChannelMembership (NonEmpty Text) Source #
The ARNs of the members you want to add to the channel.
batchCreateChannelMembership_chimeBearer :: Lens' BatchCreateChannelMembership Text Source #
The AppInstanceUserArn of the user that makes the API call.
Destructuring the Response
data BatchCreateChannelMembershipResponse Source #
See: newBatchCreateChannelMembershipResponse smart constructor.
Constructors
| BatchCreateChannelMembershipResponse' | |
Fields
| |
Instances
newBatchCreateChannelMembershipResponse Source #
Arguments
| :: Int | |
| -> BatchCreateChannelMembershipResponse |
Create a value of BatchCreateChannelMembershipResponse 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:errors:BatchCreateChannelMembershipResponse', batchCreateChannelMembershipResponse_errors - If the action fails for one or more of the memberships in the request, a
list of the memberships is returned, along with error codes and error
messages.
$sel:batchChannelMemberships:BatchCreateChannelMembershipResponse', batchCreateChannelMembershipResponse_batchChannelMemberships - The list of channel memberships in the response.
$sel:httpStatus:BatchCreateChannelMembershipResponse', batchCreateChannelMembershipResponse_httpStatus - The response's http status code.
Response Lenses
batchCreateChannelMembershipResponse_errors :: Lens' BatchCreateChannelMembershipResponse (Maybe [BatchCreateChannelMembershipError]) Source #
If the action fails for one or more of the memberships in the request, a list of the memberships is returned, along with error codes and error messages.
batchCreateChannelMembershipResponse_batchChannelMemberships :: Lens' BatchCreateChannelMembershipResponse (Maybe BatchChannelMemberships) Source #
The list of channel memberships in the response.
batchCreateChannelMembershipResponse_httpStatus :: Lens' BatchCreateChannelMembershipResponse Int Source #
The response's http status code.