| 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.Lens
Contents
- Operations
- AssociateChannelFlow
- BatchCreateChannelMembership
- ChannelFlowCallback
- CreateChannel
- CreateChannelBan
- CreateChannelFlow
- CreateChannelMembership
- CreateChannelModerator
- DeleteChannel
- DeleteChannelBan
- DeleteChannelFlow
- DeleteChannelMembership
- DeleteChannelMessage
- DeleteChannelModerator
- DescribeChannel
- DescribeChannelBan
- DescribeChannelFlow
- DescribeChannelMembership
- DescribeChannelMembershipForAppInstanceUser
- DescribeChannelModeratedByAppInstanceUser
- DescribeChannelModerator
- DisassociateChannelFlow
- GetChannelMembershipPreferences
- GetChannelMessage
- GetChannelMessageStatus
- GetMessagingSessionEndpoint
- ListChannelBans
- ListChannelFlows
- ListChannelMemberships
- ListChannelMembershipsForAppInstanceUser
- ListChannelMessages
- ListChannelModerators
- ListChannels
- ListChannelsAssociatedWithChannelFlow
- ListChannelsModeratedByAppInstanceUser
- ListSubChannels
- ListTagsForResource
- PutChannelMembershipPreferences
- RedactChannelMessage
- SearchChannels
- SendChannelMessage
- TagResource
- UntagResource
- UpdateChannel
- UpdateChannelFlow
- UpdateChannelMessage
- UpdateChannelReadMarker
- Types
- AppInstanceUserMembershipSummary
- BatchChannelMemberships
- BatchCreateChannelMembershipError
- Channel
- ChannelAssociatedWithFlowSummary
- ChannelBan
- ChannelBanSummary
- ChannelFlow
- ChannelFlowSummary
- ChannelMembership
- ChannelMembershipForAppInstanceUserSummary
- ChannelMembershipPreferences
- ChannelMembershipSummary
- ChannelMessage
- ChannelMessageCallback
- ChannelMessageStatusStructure
- ChannelMessageSummary
- ChannelModeratedByAppInstanceUserSummary
- ChannelModerator
- ChannelModeratorSummary
- ChannelSummary
- ElasticChannelConfiguration
- Identity
- LambdaConfiguration
- MessageAttributeValue
- MessagingSessionEndpoint
- Processor
- ProcessorConfiguration
- PushNotificationConfiguration
- PushNotificationPreferences
- SearchField
- SubChannelSummary
- Tag
Description
Synopsis
- associateChannelFlow_channelArn :: Lens' AssociateChannelFlow Text
- associateChannelFlow_channelFlowArn :: Lens' AssociateChannelFlow Text
- associateChannelFlow_chimeBearer :: Lens' AssociateChannelFlow Text
- batchCreateChannelMembership_subChannelId :: Lens' BatchCreateChannelMembership (Maybe Text)
- batchCreateChannelMembership_type :: Lens' BatchCreateChannelMembership (Maybe ChannelMembershipType)
- batchCreateChannelMembership_channelArn :: Lens' BatchCreateChannelMembership Text
- batchCreateChannelMembership_memberArns :: Lens' BatchCreateChannelMembership (NonEmpty Text)
- batchCreateChannelMembership_chimeBearer :: Lens' BatchCreateChannelMembership Text
- batchCreateChannelMembershipResponse_batchChannelMemberships :: Lens' BatchCreateChannelMembershipResponse (Maybe BatchChannelMemberships)
- batchCreateChannelMembershipResponse_errors :: Lens' BatchCreateChannelMembershipResponse (Maybe [BatchCreateChannelMembershipError])
- batchCreateChannelMembershipResponse_httpStatus :: Lens' BatchCreateChannelMembershipResponse Int
- channelFlowCallback_deleteResource :: Lens' ChannelFlowCallback (Maybe Bool)
- channelFlowCallback_callbackId :: Lens' ChannelFlowCallback Text
- channelFlowCallback_channelArn :: Lens' ChannelFlowCallback Text
- channelFlowCallback_channelMessage :: Lens' ChannelFlowCallback ChannelMessageCallback
- channelFlowCallbackResponse_callbackId :: Lens' ChannelFlowCallbackResponse (Maybe Text)
- channelFlowCallbackResponse_channelArn :: Lens' ChannelFlowCallbackResponse (Maybe Text)
- channelFlowCallbackResponse_httpStatus :: Lens' ChannelFlowCallbackResponse Int
- createChannel_channelId :: Lens' CreateChannel (Maybe Text)
- createChannel_elasticChannelConfiguration :: Lens' CreateChannel (Maybe ElasticChannelConfiguration)
- createChannel_memberArns :: Lens' CreateChannel (Maybe (NonEmpty Text))
- createChannel_metadata :: Lens' CreateChannel (Maybe Text)
- createChannel_mode :: Lens' CreateChannel (Maybe ChannelMode)
- createChannel_moderatorArns :: Lens' CreateChannel (Maybe (NonEmpty Text))
- createChannel_privacy :: Lens' CreateChannel (Maybe ChannelPrivacy)
- createChannel_tags :: Lens' CreateChannel (Maybe (NonEmpty Tag))
- createChannel_appInstanceArn :: Lens' CreateChannel Text
- createChannel_name :: Lens' CreateChannel Text
- createChannel_clientRequestToken :: Lens' CreateChannel Text
- createChannel_chimeBearer :: Lens' CreateChannel Text
- createChannelResponse_channelArn :: Lens' CreateChannelResponse (Maybe Text)
- createChannelResponse_httpStatus :: Lens' CreateChannelResponse Int
- createChannelBan_channelArn :: Lens' CreateChannelBan Text
- createChannelBan_memberArn :: Lens' CreateChannelBan Text
- createChannelBan_chimeBearer :: Lens' CreateChannelBan Text
- createChannelBanResponse_channelArn :: Lens' CreateChannelBanResponse (Maybe Text)
- createChannelBanResponse_member :: Lens' CreateChannelBanResponse (Maybe Identity)
- createChannelBanResponse_httpStatus :: Lens' CreateChannelBanResponse Int
- createChannelFlow_tags :: Lens' CreateChannelFlow (Maybe (NonEmpty Tag))
- createChannelFlow_appInstanceArn :: Lens' CreateChannelFlow Text
- createChannelFlow_processors :: Lens' CreateChannelFlow (NonEmpty Processor)
- createChannelFlow_name :: Lens' CreateChannelFlow Text
- createChannelFlow_clientRequestToken :: Lens' CreateChannelFlow Text
- createChannelFlowResponse_channelFlowArn :: Lens' CreateChannelFlowResponse (Maybe Text)
- createChannelFlowResponse_httpStatus :: Lens' CreateChannelFlowResponse Int
- createChannelMembership_subChannelId :: Lens' CreateChannelMembership (Maybe Text)
- createChannelMembership_channelArn :: Lens' CreateChannelMembership Text
- createChannelMembership_memberArn :: Lens' CreateChannelMembership Text
- createChannelMembership_type :: Lens' CreateChannelMembership ChannelMembershipType
- createChannelMembership_chimeBearer :: Lens' CreateChannelMembership Text
- createChannelMembershipResponse_channelArn :: Lens' CreateChannelMembershipResponse (Maybe Text)
- createChannelMembershipResponse_member :: Lens' CreateChannelMembershipResponse (Maybe Identity)
- createChannelMembershipResponse_subChannelId :: Lens' CreateChannelMembershipResponse (Maybe Text)
- createChannelMembershipResponse_httpStatus :: Lens' CreateChannelMembershipResponse Int
- createChannelModerator_channelArn :: Lens' CreateChannelModerator Text
- createChannelModerator_channelModeratorArn :: Lens' CreateChannelModerator Text
- createChannelModerator_chimeBearer :: Lens' CreateChannelModerator Text
- createChannelModeratorResponse_channelArn :: Lens' CreateChannelModeratorResponse (Maybe Text)
- createChannelModeratorResponse_channelModerator :: Lens' CreateChannelModeratorResponse (Maybe Identity)
- createChannelModeratorResponse_httpStatus :: Lens' CreateChannelModeratorResponse Int
- deleteChannel_subChannelId :: Lens' DeleteChannel (Maybe Text)
- deleteChannel_channelArn :: Lens' DeleteChannel Text
- deleteChannel_chimeBearer :: Lens' DeleteChannel Text
- deleteChannelBan_channelArn :: Lens' DeleteChannelBan Text
- deleteChannelBan_memberArn :: Lens' DeleteChannelBan Text
- deleteChannelBan_chimeBearer :: Lens' DeleteChannelBan Text
- deleteChannelFlow_channelFlowArn :: Lens' DeleteChannelFlow Text
- deleteChannelMembership_subChannelId :: Lens' DeleteChannelMembership (Maybe Text)
- deleteChannelMembership_channelArn :: Lens' DeleteChannelMembership Text
- deleteChannelMembership_memberArn :: Lens' DeleteChannelMembership Text
- deleteChannelMembership_chimeBearer :: Lens' DeleteChannelMembership Text
- deleteChannelMessage_subChannelId :: Lens' DeleteChannelMessage (Maybe Text)
- deleteChannelMessage_channelArn :: Lens' DeleteChannelMessage Text
- deleteChannelMessage_messageId :: Lens' DeleteChannelMessage Text
- deleteChannelMessage_chimeBearer :: Lens' DeleteChannelMessage Text
- deleteChannelModerator_channelArn :: Lens' DeleteChannelModerator Text
- deleteChannelModerator_channelModeratorArn :: Lens' DeleteChannelModerator Text
- deleteChannelModerator_chimeBearer :: Lens' DeleteChannelModerator Text
- describeChannel_channelArn :: Lens' DescribeChannel Text
- describeChannel_chimeBearer :: Lens' DescribeChannel Text
- describeChannelResponse_channel :: Lens' DescribeChannelResponse (Maybe Channel)
- describeChannelResponse_httpStatus :: Lens' DescribeChannelResponse Int
- describeChannelBan_channelArn :: Lens' DescribeChannelBan Text
- describeChannelBan_memberArn :: Lens' DescribeChannelBan Text
- describeChannelBan_chimeBearer :: Lens' DescribeChannelBan Text
- describeChannelBanResponse_channelBan :: Lens' DescribeChannelBanResponse (Maybe ChannelBan)
- describeChannelBanResponse_httpStatus :: Lens' DescribeChannelBanResponse Int
- describeChannelFlow_channelFlowArn :: Lens' DescribeChannelFlow Text
- describeChannelFlowResponse_channelFlow :: Lens' DescribeChannelFlowResponse (Maybe ChannelFlow)
- describeChannelFlowResponse_httpStatus :: Lens' DescribeChannelFlowResponse Int
- describeChannelMembership_subChannelId :: Lens' DescribeChannelMembership (Maybe Text)
- describeChannelMembership_channelArn :: Lens' DescribeChannelMembership Text
- describeChannelMembership_memberArn :: Lens' DescribeChannelMembership Text
- describeChannelMembership_chimeBearer :: Lens' DescribeChannelMembership Text
- describeChannelMembershipResponse_channelMembership :: Lens' DescribeChannelMembershipResponse (Maybe ChannelMembership)
- describeChannelMembershipResponse_httpStatus :: Lens' DescribeChannelMembershipResponse Int
- describeChannelMembershipForAppInstanceUser_channelArn :: Lens' DescribeChannelMembershipForAppInstanceUser Text
- describeChannelMembershipForAppInstanceUser_appInstanceUserArn :: Lens' DescribeChannelMembershipForAppInstanceUser Text
- describeChannelMembershipForAppInstanceUser_chimeBearer :: Lens' DescribeChannelMembershipForAppInstanceUser Text
- describeChannelMembershipForAppInstanceUserResponse_channelMembership :: Lens' DescribeChannelMembershipForAppInstanceUserResponse (Maybe ChannelMembershipForAppInstanceUserSummary)
- describeChannelMembershipForAppInstanceUserResponse_httpStatus :: Lens' DescribeChannelMembershipForAppInstanceUserResponse Int
- describeChannelModeratedByAppInstanceUser_channelArn :: Lens' DescribeChannelModeratedByAppInstanceUser Text
- describeChannelModeratedByAppInstanceUser_appInstanceUserArn :: Lens' DescribeChannelModeratedByAppInstanceUser Text
- describeChannelModeratedByAppInstanceUser_chimeBearer :: Lens' DescribeChannelModeratedByAppInstanceUser Text
- describeChannelModeratedByAppInstanceUserResponse_channel :: Lens' DescribeChannelModeratedByAppInstanceUserResponse (Maybe ChannelModeratedByAppInstanceUserSummary)
- describeChannelModeratedByAppInstanceUserResponse_httpStatus :: Lens' DescribeChannelModeratedByAppInstanceUserResponse Int
- describeChannelModerator_channelArn :: Lens' DescribeChannelModerator Text
- describeChannelModerator_channelModeratorArn :: Lens' DescribeChannelModerator Text
- describeChannelModerator_chimeBearer :: Lens' DescribeChannelModerator Text
- describeChannelModeratorResponse_channelModerator :: Lens' DescribeChannelModeratorResponse (Maybe ChannelModerator)
- describeChannelModeratorResponse_httpStatus :: Lens' DescribeChannelModeratorResponse Int
- disassociateChannelFlow_channelArn :: Lens' DisassociateChannelFlow Text
- disassociateChannelFlow_channelFlowArn :: Lens' DisassociateChannelFlow Text
- disassociateChannelFlow_chimeBearer :: Lens' DisassociateChannelFlow Text
- getChannelMembershipPreferences_channelArn :: Lens' GetChannelMembershipPreferences Text
- getChannelMembershipPreferences_memberArn :: Lens' GetChannelMembershipPreferences Text
- getChannelMembershipPreferences_chimeBearer :: Lens' GetChannelMembershipPreferences Text
- getChannelMembershipPreferencesResponse_channelArn :: Lens' GetChannelMembershipPreferencesResponse (Maybe Text)
- getChannelMembershipPreferencesResponse_member :: Lens' GetChannelMembershipPreferencesResponse (Maybe Identity)
- getChannelMembershipPreferencesResponse_preferences :: Lens' GetChannelMembershipPreferencesResponse (Maybe ChannelMembershipPreferences)
- getChannelMembershipPreferencesResponse_httpStatus :: Lens' GetChannelMembershipPreferencesResponse Int
- getChannelMessage_subChannelId :: Lens' GetChannelMessage (Maybe Text)
- getChannelMessage_channelArn :: Lens' GetChannelMessage Text
- getChannelMessage_messageId :: Lens' GetChannelMessage Text
- getChannelMessage_chimeBearer :: Lens' GetChannelMessage Text
- getChannelMessageResponse_channelMessage :: Lens' GetChannelMessageResponse (Maybe ChannelMessage)
- getChannelMessageResponse_httpStatus :: Lens' GetChannelMessageResponse Int
- getChannelMessageStatus_subChannelId :: Lens' GetChannelMessageStatus (Maybe Text)
- getChannelMessageStatus_channelArn :: Lens' GetChannelMessageStatus Text
- getChannelMessageStatus_messageId :: Lens' GetChannelMessageStatus Text
- getChannelMessageStatus_chimeBearer :: Lens' GetChannelMessageStatus Text
- getChannelMessageStatusResponse_status :: Lens' GetChannelMessageStatusResponse (Maybe ChannelMessageStatusStructure)
- getChannelMessageStatusResponse_httpStatus :: Lens' GetChannelMessageStatusResponse Int
- getMessagingSessionEndpointResponse_endpoint :: Lens' GetMessagingSessionEndpointResponse (Maybe MessagingSessionEndpoint)
- getMessagingSessionEndpointResponse_httpStatus :: Lens' GetMessagingSessionEndpointResponse Int
- listChannelBans_maxResults :: Lens' ListChannelBans (Maybe Natural)
- listChannelBans_nextToken :: Lens' ListChannelBans (Maybe Text)
- listChannelBans_channelArn :: Lens' ListChannelBans Text
- listChannelBans_chimeBearer :: Lens' ListChannelBans Text
- listChannelBansResponse_channelArn :: Lens' ListChannelBansResponse (Maybe Text)
- listChannelBansResponse_channelBans :: Lens' ListChannelBansResponse (Maybe [ChannelBanSummary])
- listChannelBansResponse_nextToken :: Lens' ListChannelBansResponse (Maybe Text)
- listChannelBansResponse_httpStatus :: Lens' ListChannelBansResponse Int
- listChannelFlows_maxResults :: Lens' ListChannelFlows (Maybe Natural)
- listChannelFlows_nextToken :: Lens' ListChannelFlows (Maybe Text)
- listChannelFlows_appInstanceArn :: Lens' ListChannelFlows Text
- listChannelFlowsResponse_channelFlows :: Lens' ListChannelFlowsResponse (Maybe [ChannelFlowSummary])
- listChannelFlowsResponse_nextToken :: Lens' ListChannelFlowsResponse (Maybe Text)
- listChannelFlowsResponse_httpStatus :: Lens' ListChannelFlowsResponse Int
- listChannelMemberships_maxResults :: Lens' ListChannelMemberships (Maybe Natural)
- listChannelMemberships_nextToken :: Lens' ListChannelMemberships (Maybe Text)
- listChannelMemberships_subChannelId :: Lens' ListChannelMemberships (Maybe Text)
- listChannelMemberships_type :: Lens' ListChannelMemberships (Maybe ChannelMembershipType)
- listChannelMemberships_channelArn :: Lens' ListChannelMemberships Text
- listChannelMemberships_chimeBearer :: Lens' ListChannelMemberships Text
- listChannelMembershipsResponse_channelArn :: Lens' ListChannelMembershipsResponse (Maybe Text)
- listChannelMembershipsResponse_channelMemberships :: Lens' ListChannelMembershipsResponse (Maybe [ChannelMembershipSummary])
- listChannelMembershipsResponse_nextToken :: Lens' ListChannelMembershipsResponse (Maybe Text)
- listChannelMembershipsResponse_httpStatus :: Lens' ListChannelMembershipsResponse Int
- listChannelMembershipsForAppInstanceUser_appInstanceUserArn :: Lens' ListChannelMembershipsForAppInstanceUser (Maybe Text)
- listChannelMembershipsForAppInstanceUser_maxResults :: Lens' ListChannelMembershipsForAppInstanceUser (Maybe Natural)
- listChannelMembershipsForAppInstanceUser_nextToken :: Lens' ListChannelMembershipsForAppInstanceUser (Maybe Text)
- listChannelMembershipsForAppInstanceUser_chimeBearer :: Lens' ListChannelMembershipsForAppInstanceUser Text
- listChannelMembershipsForAppInstanceUserResponse_channelMemberships :: Lens' ListChannelMembershipsForAppInstanceUserResponse (Maybe [ChannelMembershipForAppInstanceUserSummary])
- listChannelMembershipsForAppInstanceUserResponse_nextToken :: Lens' ListChannelMembershipsForAppInstanceUserResponse (Maybe Text)
- listChannelMembershipsForAppInstanceUserResponse_httpStatus :: Lens' ListChannelMembershipsForAppInstanceUserResponse Int
- listChannelMessages_maxResults :: Lens' ListChannelMessages (Maybe Natural)
- listChannelMessages_nextToken :: Lens' ListChannelMessages (Maybe Text)
- listChannelMessages_notAfter :: Lens' ListChannelMessages (Maybe UTCTime)
- listChannelMessages_notBefore :: Lens' ListChannelMessages (Maybe UTCTime)
- listChannelMessages_sortOrder :: Lens' ListChannelMessages (Maybe SortOrder)
- listChannelMessages_subChannelId :: Lens' ListChannelMessages (Maybe Text)
- listChannelMessages_channelArn :: Lens' ListChannelMessages Text
- listChannelMessages_chimeBearer :: Lens' ListChannelMessages Text
- listChannelMessagesResponse_channelArn :: Lens' ListChannelMessagesResponse (Maybe Text)
- listChannelMessagesResponse_channelMessages :: Lens' ListChannelMessagesResponse (Maybe [ChannelMessageSummary])
- listChannelMessagesResponse_nextToken :: Lens' ListChannelMessagesResponse (Maybe Text)
- listChannelMessagesResponse_subChannelId :: Lens' ListChannelMessagesResponse (Maybe Text)
- listChannelMessagesResponse_httpStatus :: Lens' ListChannelMessagesResponse Int
- listChannelModerators_maxResults :: Lens' ListChannelModerators (Maybe Natural)
- listChannelModerators_nextToken :: Lens' ListChannelModerators (Maybe Text)
- listChannelModerators_channelArn :: Lens' ListChannelModerators Text
- listChannelModerators_chimeBearer :: Lens' ListChannelModerators Text
- listChannelModeratorsResponse_channelArn :: Lens' ListChannelModeratorsResponse (Maybe Text)
- listChannelModeratorsResponse_channelModerators :: Lens' ListChannelModeratorsResponse (Maybe [ChannelModeratorSummary])
- listChannelModeratorsResponse_nextToken :: Lens' ListChannelModeratorsResponse (Maybe Text)
- listChannelModeratorsResponse_httpStatus :: Lens' ListChannelModeratorsResponse Int
- listChannels_maxResults :: Lens' ListChannels (Maybe Natural)
- listChannels_nextToken :: Lens' ListChannels (Maybe Text)
- listChannels_privacy :: Lens' ListChannels (Maybe ChannelPrivacy)
- listChannels_appInstanceArn :: Lens' ListChannels Text
- listChannels_chimeBearer :: Lens' ListChannels Text
- listChannelsResponse_channels :: Lens' ListChannelsResponse (Maybe [ChannelSummary])
- listChannelsResponse_nextToken :: Lens' ListChannelsResponse (Maybe Text)
- listChannelsResponse_httpStatus :: Lens' ListChannelsResponse Int
- listChannelsAssociatedWithChannelFlow_maxResults :: Lens' ListChannelsAssociatedWithChannelFlow (Maybe Natural)
- listChannelsAssociatedWithChannelFlow_nextToken :: Lens' ListChannelsAssociatedWithChannelFlow (Maybe Text)
- listChannelsAssociatedWithChannelFlow_channelFlowArn :: Lens' ListChannelsAssociatedWithChannelFlow Text
- listChannelsAssociatedWithChannelFlowResponse_channels :: Lens' ListChannelsAssociatedWithChannelFlowResponse (Maybe [ChannelAssociatedWithFlowSummary])
- listChannelsAssociatedWithChannelFlowResponse_nextToken :: Lens' ListChannelsAssociatedWithChannelFlowResponse (Maybe Text)
- listChannelsAssociatedWithChannelFlowResponse_httpStatus :: Lens' ListChannelsAssociatedWithChannelFlowResponse Int
- listChannelsModeratedByAppInstanceUser_appInstanceUserArn :: Lens' ListChannelsModeratedByAppInstanceUser (Maybe Text)
- listChannelsModeratedByAppInstanceUser_maxResults :: Lens' ListChannelsModeratedByAppInstanceUser (Maybe Natural)
- listChannelsModeratedByAppInstanceUser_nextToken :: Lens' ListChannelsModeratedByAppInstanceUser (Maybe Text)
- listChannelsModeratedByAppInstanceUser_chimeBearer :: Lens' ListChannelsModeratedByAppInstanceUser Text
- listChannelsModeratedByAppInstanceUserResponse_channels :: Lens' ListChannelsModeratedByAppInstanceUserResponse (Maybe [ChannelModeratedByAppInstanceUserSummary])
- listChannelsModeratedByAppInstanceUserResponse_nextToken :: Lens' ListChannelsModeratedByAppInstanceUserResponse (Maybe Text)
- listChannelsModeratedByAppInstanceUserResponse_httpStatus :: Lens' ListChannelsModeratedByAppInstanceUserResponse Int
- listSubChannels_maxResults :: Lens' ListSubChannels (Maybe Natural)
- listSubChannels_nextToken :: Lens' ListSubChannels (Maybe Text)
- listSubChannels_channelArn :: Lens' ListSubChannels Text
- listSubChannels_chimeBearer :: Lens' ListSubChannels Text
- listSubChannelsResponse_channelArn :: Lens' ListSubChannelsResponse (Maybe Text)
- listSubChannelsResponse_nextToken :: Lens' ListSubChannelsResponse (Maybe Text)
- listSubChannelsResponse_subChannels :: Lens' ListSubChannelsResponse (Maybe [SubChannelSummary])
- listSubChannelsResponse_httpStatus :: Lens' ListSubChannelsResponse Int
- listTagsForResource_resourceARN :: Lens' ListTagsForResource Text
- listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (NonEmpty Tag))
- listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int
- putChannelMembershipPreferences_channelArn :: Lens' PutChannelMembershipPreferences Text
- putChannelMembershipPreferences_memberArn :: Lens' PutChannelMembershipPreferences Text
- putChannelMembershipPreferences_chimeBearer :: Lens' PutChannelMembershipPreferences Text
- putChannelMembershipPreferences_preferences :: Lens' PutChannelMembershipPreferences ChannelMembershipPreferences
- putChannelMembershipPreferencesResponse_channelArn :: Lens' PutChannelMembershipPreferencesResponse (Maybe Text)
- putChannelMembershipPreferencesResponse_member :: Lens' PutChannelMembershipPreferencesResponse (Maybe Identity)
- putChannelMembershipPreferencesResponse_preferences :: Lens' PutChannelMembershipPreferencesResponse (Maybe ChannelMembershipPreferences)
- putChannelMembershipPreferencesResponse_httpStatus :: Lens' PutChannelMembershipPreferencesResponse Int
- redactChannelMessage_subChannelId :: Lens' RedactChannelMessage (Maybe Text)
- redactChannelMessage_channelArn :: Lens' RedactChannelMessage Text
- redactChannelMessage_messageId :: Lens' RedactChannelMessage Text
- redactChannelMessage_chimeBearer :: Lens' RedactChannelMessage Text
- redactChannelMessageResponse_channelArn :: Lens' RedactChannelMessageResponse (Maybe Text)
- redactChannelMessageResponse_messageId :: Lens' RedactChannelMessageResponse (Maybe Text)
- redactChannelMessageResponse_subChannelId :: Lens' RedactChannelMessageResponse (Maybe Text)
- redactChannelMessageResponse_httpStatus :: Lens' RedactChannelMessageResponse Int
- searchChannels_chimeBearer :: Lens' SearchChannels (Maybe Text)
- searchChannels_maxResults :: Lens' SearchChannels (Maybe Natural)
- searchChannels_nextToken :: Lens' SearchChannels (Maybe Text)
- searchChannels_fields :: Lens' SearchChannels (NonEmpty SearchField)
- searchChannelsResponse_channels :: Lens' SearchChannelsResponse (Maybe [ChannelSummary])
- searchChannelsResponse_nextToken :: Lens' SearchChannelsResponse (Maybe Text)
- searchChannelsResponse_httpStatus :: Lens' SearchChannelsResponse Int
- sendChannelMessage_messageAttributes :: Lens' SendChannelMessage (Maybe (HashMap Text MessageAttributeValue))
- sendChannelMessage_metadata :: Lens' SendChannelMessage (Maybe Text)
- sendChannelMessage_pushNotification :: Lens' SendChannelMessage (Maybe PushNotificationConfiguration)
- sendChannelMessage_subChannelId :: Lens' SendChannelMessage (Maybe Text)
- sendChannelMessage_channelArn :: Lens' SendChannelMessage Text
- sendChannelMessage_content :: Lens' SendChannelMessage Text
- sendChannelMessage_type :: Lens' SendChannelMessage ChannelMessageType
- sendChannelMessage_persistence :: Lens' SendChannelMessage ChannelMessagePersistenceType
- sendChannelMessage_clientRequestToken :: Lens' SendChannelMessage Text
- sendChannelMessage_chimeBearer :: Lens' SendChannelMessage Text
- sendChannelMessageResponse_channelArn :: Lens' SendChannelMessageResponse (Maybe Text)
- sendChannelMessageResponse_messageId :: Lens' SendChannelMessageResponse (Maybe Text)
- sendChannelMessageResponse_status :: Lens' SendChannelMessageResponse (Maybe ChannelMessageStatusStructure)
- sendChannelMessageResponse_subChannelId :: Lens' SendChannelMessageResponse (Maybe Text)
- sendChannelMessageResponse_httpStatus :: Lens' SendChannelMessageResponse Int
- tagResource_resourceARN :: Lens' TagResource Text
- tagResource_tags :: Lens' TagResource (NonEmpty Tag)
- untagResource_resourceARN :: Lens' UntagResource Text
- untagResource_tagKeys :: Lens' UntagResource (NonEmpty Text)
- updateChannel_metadata :: Lens' UpdateChannel (Maybe Text)
- updateChannel_mode :: Lens' UpdateChannel (Maybe ChannelMode)
- updateChannel_name :: Lens' UpdateChannel (Maybe Text)
- updateChannel_channelArn :: Lens' UpdateChannel Text
- updateChannel_chimeBearer :: Lens' UpdateChannel Text
- updateChannelResponse_channelArn :: Lens' UpdateChannelResponse (Maybe Text)
- updateChannelResponse_httpStatus :: Lens' UpdateChannelResponse Int
- updateChannelFlow_channelFlowArn :: Lens' UpdateChannelFlow Text
- updateChannelFlow_processors :: Lens' UpdateChannelFlow (NonEmpty Processor)
- updateChannelFlow_name :: Lens' UpdateChannelFlow Text
- updateChannelFlowResponse_channelFlowArn :: Lens' UpdateChannelFlowResponse (Maybe Text)
- updateChannelFlowResponse_httpStatus :: Lens' UpdateChannelFlowResponse Int
- updateChannelMessage_content :: Lens' UpdateChannelMessage (Maybe Text)
- updateChannelMessage_metadata :: Lens' UpdateChannelMessage (Maybe Text)
- updateChannelMessage_subChannelId :: Lens' UpdateChannelMessage (Maybe Text)
- updateChannelMessage_channelArn :: Lens' UpdateChannelMessage Text
- updateChannelMessage_messageId :: Lens' UpdateChannelMessage Text
- updateChannelMessage_chimeBearer :: Lens' UpdateChannelMessage Text
- updateChannelMessageResponse_channelArn :: Lens' UpdateChannelMessageResponse (Maybe Text)
- updateChannelMessageResponse_messageId :: Lens' UpdateChannelMessageResponse (Maybe Text)
- updateChannelMessageResponse_status :: Lens' UpdateChannelMessageResponse (Maybe ChannelMessageStatusStructure)
- updateChannelMessageResponse_subChannelId :: Lens' UpdateChannelMessageResponse (Maybe Text)
- updateChannelMessageResponse_httpStatus :: Lens' UpdateChannelMessageResponse Int
- updateChannelReadMarker_subChannelId :: Lens' UpdateChannelReadMarker (Maybe Text)
- updateChannelReadMarker_channelArn :: Lens' UpdateChannelReadMarker Text
- updateChannelReadMarker_chimeBearer :: Lens' UpdateChannelReadMarker Text
- updateChannelReadMarkerResponse_channelArn :: Lens' UpdateChannelReadMarkerResponse (Maybe Text)
- updateChannelReadMarkerResponse_subChannelId :: Lens' UpdateChannelReadMarkerResponse (Maybe Text)
- updateChannelReadMarkerResponse_httpStatus :: Lens' UpdateChannelReadMarkerResponse Int
- appInstanceUserMembershipSummary_readMarkerTimestamp :: Lens' AppInstanceUserMembershipSummary (Maybe UTCTime)
- appInstanceUserMembershipSummary_subChannelId :: Lens' AppInstanceUserMembershipSummary (Maybe Text)
- appInstanceUserMembershipSummary_type :: Lens' AppInstanceUserMembershipSummary (Maybe ChannelMembershipType)
- batchChannelMemberships_channelArn :: Lens' BatchChannelMemberships (Maybe Text)
- batchChannelMemberships_invitedBy :: Lens' BatchChannelMemberships (Maybe Identity)
- batchChannelMemberships_members :: Lens' BatchChannelMemberships (Maybe [Identity])
- batchChannelMemberships_subChannelId :: Lens' BatchChannelMemberships (Maybe Text)
- batchChannelMemberships_type :: Lens' BatchChannelMemberships (Maybe ChannelMembershipType)
- batchCreateChannelMembershipError_errorCode :: Lens' BatchCreateChannelMembershipError (Maybe ErrorCode)
- batchCreateChannelMembershipError_errorMessage :: Lens' BatchCreateChannelMembershipError (Maybe Text)
- batchCreateChannelMembershipError_memberArn :: Lens' BatchCreateChannelMembershipError (Maybe Text)
- channel_channelArn :: Lens' Channel (Maybe Text)
- channel_channelFlowArn :: Lens' Channel (Maybe Text)
- channel_createdBy :: Lens' Channel (Maybe Identity)
- channel_createdTimestamp :: Lens' Channel (Maybe UTCTime)
- channel_elasticChannelConfiguration :: Lens' Channel (Maybe ElasticChannelConfiguration)
- channel_lastMessageTimestamp :: Lens' Channel (Maybe UTCTime)
- channel_lastUpdatedTimestamp :: Lens' Channel (Maybe UTCTime)
- channel_metadata :: Lens' Channel (Maybe Text)
- channel_mode :: Lens' Channel (Maybe ChannelMode)
- channel_name :: Lens' Channel (Maybe Text)
- channel_privacy :: Lens' Channel (Maybe ChannelPrivacy)
- channelAssociatedWithFlowSummary_channelArn :: Lens' ChannelAssociatedWithFlowSummary (Maybe Text)
- channelAssociatedWithFlowSummary_metadata :: Lens' ChannelAssociatedWithFlowSummary (Maybe Text)
- channelAssociatedWithFlowSummary_mode :: Lens' ChannelAssociatedWithFlowSummary (Maybe ChannelMode)
- channelAssociatedWithFlowSummary_name :: Lens' ChannelAssociatedWithFlowSummary (Maybe Text)
- channelAssociatedWithFlowSummary_privacy :: Lens' ChannelAssociatedWithFlowSummary (Maybe ChannelPrivacy)
- channelBan_channelArn :: Lens' ChannelBan (Maybe Text)
- channelBan_createdBy :: Lens' ChannelBan (Maybe Identity)
- channelBan_createdTimestamp :: Lens' ChannelBan (Maybe UTCTime)
- channelBan_member :: Lens' ChannelBan (Maybe Identity)
- channelBanSummary_member :: Lens' ChannelBanSummary (Maybe Identity)
- channelFlow_channelFlowArn :: Lens' ChannelFlow (Maybe Text)
- channelFlow_createdTimestamp :: Lens' ChannelFlow (Maybe UTCTime)
- channelFlow_lastUpdatedTimestamp :: Lens' ChannelFlow (Maybe UTCTime)
- channelFlow_name :: Lens' ChannelFlow (Maybe Text)
- channelFlow_processors :: Lens' ChannelFlow (Maybe (NonEmpty Processor))
- channelFlowSummary_channelFlowArn :: Lens' ChannelFlowSummary (Maybe Text)
- channelFlowSummary_name :: Lens' ChannelFlowSummary (Maybe Text)
- channelFlowSummary_processors :: Lens' ChannelFlowSummary (Maybe (NonEmpty Processor))
- channelMembership_channelArn :: Lens' ChannelMembership (Maybe Text)
- channelMembership_createdTimestamp :: Lens' ChannelMembership (Maybe UTCTime)
- channelMembership_invitedBy :: Lens' ChannelMembership (Maybe Identity)
- channelMembership_lastUpdatedTimestamp :: Lens' ChannelMembership (Maybe UTCTime)
- channelMembership_member :: Lens' ChannelMembership (Maybe Identity)
- channelMembership_subChannelId :: Lens' ChannelMembership (Maybe Text)
- channelMembership_type :: Lens' ChannelMembership (Maybe ChannelMembershipType)
- channelMembershipForAppInstanceUserSummary_appInstanceUserMembershipSummary :: Lens' ChannelMembershipForAppInstanceUserSummary (Maybe AppInstanceUserMembershipSummary)
- channelMembershipForAppInstanceUserSummary_channelSummary :: Lens' ChannelMembershipForAppInstanceUserSummary (Maybe ChannelSummary)
- channelMembershipPreferences_pushNotifications :: Lens' ChannelMembershipPreferences (Maybe PushNotificationPreferences)
- channelMembershipSummary_member :: Lens' ChannelMembershipSummary (Maybe Identity)
- channelMessage_channelArn :: Lens' ChannelMessage (Maybe Text)
- channelMessage_content :: Lens' ChannelMessage (Maybe Text)
- channelMessage_createdTimestamp :: Lens' ChannelMessage (Maybe UTCTime)
- channelMessage_lastEditedTimestamp :: Lens' ChannelMessage (Maybe UTCTime)
- channelMessage_lastUpdatedTimestamp :: Lens' ChannelMessage (Maybe UTCTime)
- channelMessage_messageAttributes :: Lens' ChannelMessage (Maybe (HashMap Text MessageAttributeValue))
- channelMessage_messageId :: Lens' ChannelMessage (Maybe Text)
- channelMessage_metadata :: Lens' ChannelMessage (Maybe Text)
- channelMessage_persistence :: Lens' ChannelMessage (Maybe ChannelMessagePersistenceType)
- channelMessage_redacted :: Lens' ChannelMessage (Maybe Bool)
- channelMessage_sender :: Lens' ChannelMessage (Maybe Identity)
- channelMessage_status :: Lens' ChannelMessage (Maybe ChannelMessageStatusStructure)
- channelMessage_subChannelId :: Lens' ChannelMessage (Maybe Text)
- channelMessage_type :: Lens' ChannelMessage (Maybe ChannelMessageType)
- channelMessageCallback_content :: Lens' ChannelMessageCallback (Maybe Text)
- channelMessageCallback_messageAttributes :: Lens' ChannelMessageCallback (Maybe (HashMap Text MessageAttributeValue))
- channelMessageCallback_metadata :: Lens' ChannelMessageCallback (Maybe Text)
- channelMessageCallback_pushNotification :: Lens' ChannelMessageCallback (Maybe PushNotificationConfiguration)
- channelMessageCallback_subChannelId :: Lens' ChannelMessageCallback (Maybe Text)
- channelMessageCallback_messageId :: Lens' ChannelMessageCallback Text
- channelMessageStatusStructure_detail :: Lens' ChannelMessageStatusStructure (Maybe Text)
- channelMessageStatusStructure_value :: Lens' ChannelMessageStatusStructure (Maybe ChannelMessageStatus)
- channelMessageSummary_content :: Lens' ChannelMessageSummary (Maybe Text)
- channelMessageSummary_createdTimestamp :: Lens' ChannelMessageSummary (Maybe UTCTime)
- channelMessageSummary_lastEditedTimestamp :: Lens' ChannelMessageSummary (Maybe UTCTime)
- channelMessageSummary_lastUpdatedTimestamp :: Lens' ChannelMessageSummary (Maybe UTCTime)
- channelMessageSummary_messageAttributes :: Lens' ChannelMessageSummary (Maybe (HashMap Text MessageAttributeValue))
- channelMessageSummary_messageId :: Lens' ChannelMessageSummary (Maybe Text)
- channelMessageSummary_metadata :: Lens' ChannelMessageSummary (Maybe Text)
- channelMessageSummary_redacted :: Lens' ChannelMessageSummary (Maybe Bool)
- channelMessageSummary_sender :: Lens' ChannelMessageSummary (Maybe Identity)
- channelMessageSummary_status :: Lens' ChannelMessageSummary (Maybe ChannelMessageStatusStructure)
- channelMessageSummary_type :: Lens' ChannelMessageSummary (Maybe ChannelMessageType)
- channelModeratedByAppInstanceUserSummary_channelSummary :: Lens' ChannelModeratedByAppInstanceUserSummary (Maybe ChannelSummary)
- channelModerator_channelArn :: Lens' ChannelModerator (Maybe Text)
- channelModerator_createdBy :: Lens' ChannelModerator (Maybe Identity)
- channelModerator_createdTimestamp :: Lens' ChannelModerator (Maybe UTCTime)
- channelModerator_moderator :: Lens' ChannelModerator (Maybe Identity)
- channelModeratorSummary_moderator :: Lens' ChannelModeratorSummary (Maybe Identity)
- channelSummary_channelArn :: Lens' ChannelSummary (Maybe Text)
- channelSummary_lastMessageTimestamp :: Lens' ChannelSummary (Maybe UTCTime)
- channelSummary_metadata :: Lens' ChannelSummary (Maybe Text)
- channelSummary_mode :: Lens' ChannelSummary (Maybe ChannelMode)
- channelSummary_name :: Lens' ChannelSummary (Maybe Text)
- channelSummary_privacy :: Lens' ChannelSummary (Maybe ChannelPrivacy)
- elasticChannelConfiguration_maximumSubChannels :: Lens' ElasticChannelConfiguration Natural
- elasticChannelConfiguration_targetMembershipsPerSubChannel :: Lens' ElasticChannelConfiguration Natural
- elasticChannelConfiguration_minimumMembershipPercentage :: Lens' ElasticChannelConfiguration Natural
- identity_arn :: Lens' Identity (Maybe Text)
- identity_name :: Lens' Identity (Maybe Text)
- lambdaConfiguration_resourceArn :: Lens' LambdaConfiguration Text
- lambdaConfiguration_invocationType :: Lens' LambdaConfiguration InvocationType
- messageAttributeValue_stringValues :: Lens' MessageAttributeValue (Maybe [Text])
- messagingSessionEndpoint_url :: Lens' MessagingSessionEndpoint (Maybe Text)
- processor_name :: Lens' Processor Text
- processor_configuration :: Lens' Processor ProcessorConfiguration
- processor_executionOrder :: Lens' Processor Natural
- processor_fallbackAction :: Lens' Processor FallbackAction
- processorConfiguration_lambda :: Lens' ProcessorConfiguration LambdaConfiguration
- pushNotificationConfiguration_body :: Lens' PushNotificationConfiguration (Maybe Text)
- pushNotificationConfiguration_title :: Lens' PushNotificationConfiguration (Maybe Text)
- pushNotificationConfiguration_type :: Lens' PushNotificationConfiguration (Maybe PushNotificationType)
- pushNotificationPreferences_filterRule :: Lens' PushNotificationPreferences (Maybe Text)
- pushNotificationPreferences_allowNotifications :: Lens' PushNotificationPreferences AllowNotifications
- searchField_key :: Lens' SearchField SearchFieldKey
- searchField_values :: Lens' SearchField (NonEmpty Text)
- searchField_operator :: Lens' SearchField SearchFieldOperator
- subChannelSummary_membershipCount :: Lens' SubChannelSummary (Maybe Int)
- subChannelSummary_subChannelId :: Lens' SubChannelSummary (Maybe Text)
- tag_key :: Lens' Tag Text
- tag_value :: Lens' Tag Text
Operations
AssociateChannelFlow
associateChannelFlow_channelArn :: Lens' AssociateChannelFlow Text Source #
The ARN of the channel.
associateChannelFlow_channelFlowArn :: Lens' AssociateChannelFlow Text Source #
The ARN of the channel flow.
associateChannelFlow_chimeBearer :: Lens' AssociateChannelFlow Text Source #
The AppInstanceUserArn of the user making the API call.
BatchCreateChannelMembership
batchCreateChannelMembership_subChannelId :: Lens' BatchCreateChannelMembership (Maybe Text) Source #
The ID of the SubChannel in the request.
Only required when creating membership in a SubChannel for a moderator in an elastic channel.
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 AppInstanceUserArns 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.
batchCreateChannelMembershipResponse_batchChannelMemberships :: Lens' BatchCreateChannelMembershipResponse (Maybe BatchChannelMemberships) Source #
The list of channel memberships in the response.
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_httpStatus :: Lens' BatchCreateChannelMembershipResponse Int Source #
The response's http status code.
ChannelFlowCallback
channelFlowCallback_deleteResource :: Lens' ChannelFlowCallback (Maybe Bool) Source #
When a processor determines that a message needs to be DENIED, pass
this parameter with a value of true.
channelFlowCallback_callbackId :: Lens' ChannelFlowCallback Text Source #
The identifier passed to the processor by the service when invoked. Use the identifier to call back the service.
channelFlowCallback_channelArn :: Lens' ChannelFlowCallback Text Source #
The ARN of the channel.
channelFlowCallback_channelMessage :: Lens' ChannelFlowCallback ChannelMessageCallback Source #
Stores information about the processed message.
channelFlowCallbackResponse_callbackId :: Lens' ChannelFlowCallbackResponse (Maybe Text) Source #
The call back ID passed in the request.
channelFlowCallbackResponse_channelArn :: Lens' ChannelFlowCallbackResponse (Maybe Text) Source #
The ARN of the channel.
channelFlowCallbackResponse_httpStatus :: Lens' ChannelFlowCallbackResponse Int Source #
The response's http status code.
CreateChannel
createChannel_channelId :: Lens' CreateChannel (Maybe Text) Source #
The ID of the channel in the request.
createChannel_elasticChannelConfiguration :: Lens' CreateChannel (Maybe ElasticChannelConfiguration) Source #
The attributes required to configure and create an elastic channel. An elastic channel can support a maximum of 1-million users, excluding moderators.
createChannel_memberArns :: Lens' CreateChannel (Maybe (NonEmpty Text)) Source #
The ARNs of the channel members in the request.
createChannel_metadata :: Lens' CreateChannel (Maybe Text) Source #
The metadata of the creation request. Limited to 1KB and UTF-8.
createChannel_mode :: Lens' CreateChannel (Maybe ChannelMode) Source #
The channel mode: UNRESTRICTED or RESTRICTED. Administrators,
moderators, and channel members can add themselves and other members to
unrestricted channels. Only administrators and moderators can add
members to restricted channels.
createChannel_moderatorArns :: Lens' CreateChannel (Maybe (NonEmpty Text)) Source #
The ARNs of the channel moderators in the request.
createChannel_privacy :: Lens' CreateChannel (Maybe ChannelPrivacy) Source #
The channel's privacy level: PUBLIC or PRIVATE. Private channels
aren't discoverable by users outside the channel. Public channels are
discoverable by anyone in the AppInstance.
createChannel_tags :: Lens' CreateChannel (Maybe (NonEmpty Tag)) Source #
The tags for the creation request.
createChannel_appInstanceArn :: Lens' CreateChannel Text Source #
The ARN of the channel request.
createChannel_name :: Lens' CreateChannel Text Source #
The name of the channel.
createChannel_clientRequestToken :: Lens' CreateChannel Text Source #
The client token for the request. An Idempotency token.
createChannel_chimeBearer :: Lens' CreateChannel Text Source #
The AppInstanceUserArn of the user that makes the API call.
createChannelResponse_channelArn :: Lens' CreateChannelResponse (Maybe Text) Source #
The ARN of the channel.
createChannelResponse_httpStatus :: Lens' CreateChannelResponse Int Source #
The response's http status code.
CreateChannelBan
createChannelBan_channelArn :: Lens' CreateChannelBan Text Source #
The ARN of the ban request.
createChannelBan_memberArn :: Lens' CreateChannelBan Text Source #
The AppInstanceUserArn of the member being banned.
createChannelBan_chimeBearer :: Lens' CreateChannelBan Text Source #
The AppInstanceUserArn of the user that makes the API call.
createChannelBanResponse_channelArn :: Lens' CreateChannelBanResponse (Maybe Text) Source #
The ARN of the response to the ban request.
createChannelBanResponse_member :: Lens' CreateChannelBanResponse (Maybe Identity) Source #
The ChannelArn and BannedIdentity of the member in the ban response.
createChannelBanResponse_httpStatus :: Lens' CreateChannelBanResponse Int Source #
The response's http status code.
CreateChannelFlow
createChannelFlow_tags :: Lens' CreateChannelFlow (Maybe (NonEmpty Tag)) Source #
The tags for the creation request.
createChannelFlow_appInstanceArn :: Lens' CreateChannelFlow Text Source #
The ARN of the channel flow request.
createChannelFlow_processors :: Lens' CreateChannelFlow (NonEmpty Processor) Source #
Information about the processor Lambda functions.
createChannelFlow_name :: Lens' CreateChannelFlow Text Source #
The name of the channel flow.
createChannelFlow_clientRequestToken :: Lens' CreateChannelFlow Text Source #
The client token for the request. An Idempotency token.
createChannelFlowResponse_channelFlowArn :: Lens' CreateChannelFlowResponse (Maybe Text) Source #
The ARN of the channel flow.
createChannelFlowResponse_httpStatus :: Lens' CreateChannelFlowResponse Int Source #
The response's http status code.
CreateChannelMembership
createChannelMembership_subChannelId :: Lens' CreateChannelMembership (Maybe Text) Source #
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 Source #
The ARN of the channel to which you're adding users.
createChannelMembership_memberArn :: Lens' CreateChannelMembership Text Source #
The AppInstanceUserArn 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.
createChannelMembership_chimeBearer :: Lens' CreateChannelMembership Text Source #
The AppInstanceUserArn of the user that makes the API call.
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_subChannelId :: Lens' CreateChannelMembershipResponse (Maybe Text) Source #
The ID of the SubChannel in the response.
createChannelMembershipResponse_httpStatus :: Lens' CreateChannelMembershipResponse Int Source #
The response's http status code.
CreateChannelModerator
createChannelModerator_channelArn :: Lens' CreateChannelModerator Text Source #
The ARN of the channel.
createChannelModerator_channelModeratorArn :: Lens' CreateChannelModerator Text Source #
The AppInstanceUserArn of the moderator.
createChannelModerator_chimeBearer :: Lens' CreateChannelModerator Text Source #
The AppInstanceUserArn of the user that makes the API call.
createChannelModeratorResponse_channelArn :: Lens' CreateChannelModeratorResponse (Maybe Text) Source #
The ARN of the channel.
createChannelModeratorResponse_channelModerator :: Lens' CreateChannelModeratorResponse (Maybe Identity) Source #
The ARNs of the channel and the moderator.
createChannelModeratorResponse_httpStatus :: Lens' CreateChannelModeratorResponse Int Source #
The response's http status code.
DeleteChannel
deleteChannel_subChannelId :: Lens' DeleteChannel (Maybe Text) Source #
The ID of the SubChannel in the request.
deleteChannel_channelArn :: Lens' DeleteChannel Text Source #
The ARN of the channel being deleted.
deleteChannel_chimeBearer :: Lens' DeleteChannel Text Source #
The AppInstanceUserArn of the user that makes the API call.
DeleteChannelBan
deleteChannelBan_channelArn :: Lens' DeleteChannelBan Text Source #
The ARN of the channel from which the AppInstanceUser was banned.
deleteChannelBan_memberArn :: Lens' DeleteChannelBan Text Source #
The ARN of the AppInstanceUser that you want to reinstate.
deleteChannelBan_chimeBearer :: Lens' DeleteChannelBan Text Source #
The AppInstanceUserArn of the user that makes the API call.
DeleteChannelFlow
deleteChannelFlow_channelFlowArn :: Lens' DeleteChannelFlow Text Source #
The ARN of the channel flow.
DeleteChannelMembership
deleteChannelMembership_subChannelId :: Lens' DeleteChannelMembership (Maybe Text) Source #
The ID of the SubChannel in the request.
Only for use by moderators.
deleteChannelMembership_channelArn :: Lens' DeleteChannelMembership Text Source #
The ARN of the channel from which you want to remove the user.
deleteChannelMembership_memberArn :: Lens' DeleteChannelMembership Text Source #
The AppInstanceUserArn of the member that you're removing from the
channel.
deleteChannelMembership_chimeBearer :: Lens' DeleteChannelMembership Text Source #
The AppInstanceUserArn of the user that makes the API call.
DeleteChannelMessage
deleteChannelMessage_subChannelId :: Lens' DeleteChannelMessage (Maybe Text) Source #
The ID of the SubChannel in the request.
Only required when deleting messages in a SubChannel that the user belongs to.
deleteChannelMessage_channelArn :: Lens' DeleteChannelMessage Text Source #
The ARN of the channel.
deleteChannelMessage_messageId :: Lens' DeleteChannelMessage Text Source #
The ID of the message being deleted.
deleteChannelMessage_chimeBearer :: Lens' DeleteChannelMessage Text Source #
The AppInstanceUserArn of the user that makes the API call.
DeleteChannelModerator
deleteChannelModerator_channelArn :: Lens' DeleteChannelModerator Text Source #
The ARN of the channel.
deleteChannelModerator_channelModeratorArn :: Lens' DeleteChannelModerator Text Source #
The AppInstanceUserArn of the moderator being deleted.
deleteChannelModerator_chimeBearer :: Lens' DeleteChannelModerator Text Source #
The AppInstanceUserArn of the user that makes the API call.
DescribeChannel
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.
describeChannelResponse_channel :: Lens' DescribeChannelResponse (Maybe Channel) Source #
The channel details.
describeChannelResponse_httpStatus :: Lens' DescribeChannelResponse Int Source #
The response's http status code.
DescribeChannelBan
describeChannelBan_channelArn :: Lens' DescribeChannelBan Text Source #
The ARN of the channel from which the user is banned.
describeChannelBan_memberArn :: Lens' DescribeChannelBan Text Source #
The AppInstanceUserArn of the member being banned.
describeChannelBan_chimeBearer :: Lens' DescribeChannelBan Text Source #
The AppInstanceUserArn of the user that makes the API call.
describeChannelBanResponse_channelBan :: Lens' DescribeChannelBanResponse (Maybe ChannelBan) Source #
The details of the ban.
describeChannelBanResponse_httpStatus :: Lens' DescribeChannelBanResponse Int Source #
The response's http status code.
DescribeChannelFlow
describeChannelFlow_channelFlowArn :: Lens' DescribeChannelFlow Text Source #
The ARN of the channel flow.
describeChannelFlowResponse_channelFlow :: Lens' DescribeChannelFlowResponse (Maybe ChannelFlow) Source #
The channel flow details.
describeChannelFlowResponse_httpStatus :: Lens' DescribeChannelFlowResponse Int Source #
The response's http status code.
DescribeChannelMembership
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.
describeChannelMembershipResponse_channelMembership :: Lens' DescribeChannelMembershipResponse (Maybe ChannelMembership) Source #
The details of the membership.
describeChannelMembershipResponse_httpStatus :: Lens' DescribeChannelMembershipResponse Int Source #
The response's http status code.
DescribeChannelMembershipForAppInstanceUser
describeChannelMembershipForAppInstanceUser_channelArn :: Lens' DescribeChannelMembershipForAppInstanceUser Text Source #
The ARN of the channel to which the user belongs.
describeChannelMembershipForAppInstanceUser_appInstanceUserArn :: Lens' DescribeChannelMembershipForAppInstanceUser Text Source #
The ARN of the user in a channel.
describeChannelMembershipForAppInstanceUser_chimeBearer :: Lens' DescribeChannelMembershipForAppInstanceUser Text Source #
The AppInstanceUserArn of the user that makes the API call.
describeChannelMembershipForAppInstanceUserResponse_channelMembership :: Lens' DescribeChannelMembershipForAppInstanceUserResponse (Maybe ChannelMembershipForAppInstanceUserSummary) Source #
The channel to which a user belongs.
describeChannelMembershipForAppInstanceUserResponse_httpStatus :: Lens' DescribeChannelMembershipForAppInstanceUserResponse Int Source #
The response's http status code.
DescribeChannelModeratedByAppInstanceUser
describeChannelModeratedByAppInstanceUser_channelArn :: Lens' DescribeChannelModeratedByAppInstanceUser Text Source #
The ARN of the moderated channel.
describeChannelModeratedByAppInstanceUser_appInstanceUserArn :: Lens' DescribeChannelModeratedByAppInstanceUser Text Source #
The ARN of the AppInstanceUser in the moderated channel.
describeChannelModeratedByAppInstanceUser_chimeBearer :: Lens' DescribeChannelModeratedByAppInstanceUser Text Source #
The AppInstanceUserArn of the user that makes the API call.
describeChannelModeratedByAppInstanceUserResponse_channel :: Lens' DescribeChannelModeratedByAppInstanceUserResponse (Maybe ChannelModeratedByAppInstanceUserSummary) Source #
The moderated channel.
describeChannelModeratedByAppInstanceUserResponse_httpStatus :: Lens' DescribeChannelModeratedByAppInstanceUserResponse Int Source #
The response's http status code.
DescribeChannelModerator
describeChannelModerator_channelArn :: Lens' DescribeChannelModerator Text Source #
The ARN of the channel.
describeChannelModerator_channelModeratorArn :: Lens' DescribeChannelModerator Text Source #
The AppInstanceUserArn of the channel moderator.
describeChannelModerator_chimeBearer :: Lens' DescribeChannelModerator Text Source #
The AppInstanceUserArn of the user that makes the API call.
describeChannelModeratorResponse_channelModerator :: Lens' DescribeChannelModeratorResponse (Maybe ChannelModerator) Source #
The details of the channel moderator.
describeChannelModeratorResponse_httpStatus :: Lens' DescribeChannelModeratorResponse Int Source #
The response's http status code.
DisassociateChannelFlow
disassociateChannelFlow_channelArn :: Lens' DisassociateChannelFlow Text Source #
The ARN of the channel.
disassociateChannelFlow_channelFlowArn :: Lens' DisassociateChannelFlow Text Source #
The ARN of the channel flow.
disassociateChannelFlow_chimeBearer :: Lens' DisassociateChannelFlow Text Source #
The AppInstanceUserArn of the user making the API call.
GetChannelMembershipPreferences
getChannelMembershipPreferences_channelArn :: Lens' GetChannelMembershipPreferences Text Source #
The ARN of the channel.
getChannelMembershipPreferences_memberArn :: Lens' GetChannelMembershipPreferences Text Source #
The AppInstanceUserArn of the member retrieving the preferences.
getChannelMembershipPreferences_chimeBearer :: Lens' GetChannelMembershipPreferences Text Source #
The AppInstanceUserARN of the user making the API call.
getChannelMembershipPreferencesResponse_channelArn :: Lens' GetChannelMembershipPreferencesResponse (Maybe Text) Source #
The ARN of the channel.
getChannelMembershipPreferencesResponse_member :: Lens' GetChannelMembershipPreferencesResponse (Maybe Identity) Source #
The details of a user.
getChannelMembershipPreferencesResponse_preferences :: Lens' GetChannelMembershipPreferencesResponse (Maybe ChannelMembershipPreferences) Source #
The channel membership preferences for an AppInstanceUser .
getChannelMembershipPreferencesResponse_httpStatus :: Lens' GetChannelMembershipPreferencesResponse Int Source #
The response's http status code.
GetChannelMessage
getChannelMessage_subChannelId :: Lens' GetChannelMessage (Maybe Text) Source #
The ID of the SubChannel in the request.
Only required when getting messages in a SubChannel that the user belongs to.
getChannelMessage_channelArn :: Lens' GetChannelMessage Text Source #
The ARN of the channel.
getChannelMessage_messageId :: Lens' GetChannelMessage Text Source #
The ID of the message.
getChannelMessage_chimeBearer :: Lens' GetChannelMessage Text Source #
The AppInstanceUserArn of the user that makes the API call.
getChannelMessageResponse_channelMessage :: Lens' GetChannelMessageResponse (Maybe ChannelMessage) Source #
The details of and content in the message.
getChannelMessageResponse_httpStatus :: Lens' GetChannelMessageResponse Int Source #
The response's http status code.
GetChannelMessageStatus
getChannelMessageStatus_subChannelId :: Lens' GetChannelMessageStatus (Maybe Text) Source #
The ID of the SubChannel in the request.
Only required when getting message status in a SubChannel that the user belongs to.
getChannelMessageStatus_channelArn :: Lens' GetChannelMessageStatus Text Source #
The ARN of the channel
getChannelMessageStatus_messageId :: Lens' GetChannelMessageStatus Text Source #
The ID of the message.
getChannelMessageStatus_chimeBearer :: Lens' GetChannelMessageStatus Text Source #
The AppInstanceUserArn of the user making the API call.
getChannelMessageStatusResponse_status :: Lens' GetChannelMessageStatusResponse (Maybe ChannelMessageStatusStructure) Source #
The message status and details.
getChannelMessageStatusResponse_httpStatus :: Lens' GetChannelMessageStatusResponse Int Source #
The response's http status code.
GetMessagingSessionEndpoint
getMessagingSessionEndpointResponse_endpoint :: Lens' GetMessagingSessionEndpointResponse (Maybe MessagingSessionEndpoint) Source #
The endpoint returned in the response.
getMessagingSessionEndpointResponse_httpStatus :: Lens' GetMessagingSessionEndpointResponse Int Source #
The response's http status code.
ListChannelBans
listChannelBans_maxResults :: Lens' ListChannelBans (Maybe Natural) Source #
The maximum number of bans that you want returned.
listChannelBans_nextToken :: Lens' ListChannelBans (Maybe Text) Source #
The token passed by previous API calls until all requested bans are returned.
listChannelBans_channelArn :: Lens' ListChannelBans Text Source #
The ARN of the channel.
listChannelBans_chimeBearer :: Lens' ListChannelBans Text Source #
The AppInstanceUserArn of the user that makes the API call.
listChannelBansResponse_channelArn :: Lens' ListChannelBansResponse (Maybe Text) Source #
The ARN of the channel.
listChannelBansResponse_channelBans :: Lens' ListChannelBansResponse (Maybe [ChannelBanSummary]) Source #
The information for each requested ban.
listChannelBansResponse_nextToken :: Lens' ListChannelBansResponse (Maybe Text) Source #
The token passed by previous API calls until all requested bans are returned.
listChannelBansResponse_httpStatus :: Lens' ListChannelBansResponse Int Source #
The response's http status code.
ListChannelFlows
listChannelFlows_maxResults :: Lens' ListChannelFlows (Maybe Natural) Source #
The maximum number of channel flows that you want to return.
listChannelFlows_nextToken :: Lens' ListChannelFlows (Maybe Text) Source #
The token passed by previous API calls until all requested channel flows are returned.
listChannelFlows_appInstanceArn :: Lens' ListChannelFlows Text Source #
The ARN of the app instance.
listChannelFlowsResponse_channelFlows :: Lens' ListChannelFlowsResponse (Maybe [ChannelFlowSummary]) Source #
The information about each channel flow.
listChannelFlowsResponse_nextToken :: Lens' ListChannelFlowsResponse (Maybe Text) Source #
The token passed by previous API calls until all requested channels are returned.
listChannelFlowsResponse_httpStatus :: Lens' ListChannelFlowsResponse Int Source #
The response's http status code.
ListChannelMemberships
listChannelMemberships_maxResults :: Lens' ListChannelMemberships (Maybe Natural) Source #
The maximum number of channel memberships that you want returned.
listChannelMemberships_nextToken :: Lens' ListChannelMemberships (Maybe Text) Source #
The token passed by previous API calls until all requested channel memberships are returned.
listChannelMemberships_subChannelId :: Lens' ListChannelMemberships (Maybe Text) Source #
The ID of the SubChannel in the request.
Only required when listing a user's memberships in a particular sub-channel of an elastic channel.
listChannelMemberships_type :: Lens' ListChannelMemberships (Maybe ChannelMembershipType) Source #
The membership type of a user, DEFAULT or HIDDEN. Default members
are returned as part of ListChannelMemberships if no type is
specified. Hidden members are only returned if the type filter in
ListChannelMemberships equals HIDDEN.
listChannelMemberships_channelArn :: Lens' ListChannelMemberships Text Source #
The maximum number of channel memberships that you want returned.
listChannelMemberships_chimeBearer :: Lens' ListChannelMemberships Text Source #
The AppInstanceUserArn of the user that makes the API call.
listChannelMembershipsResponse_channelArn :: Lens' ListChannelMembershipsResponse (Maybe Text) Source #
The ARN of the channel.
listChannelMembershipsResponse_channelMemberships :: Lens' ListChannelMembershipsResponse (Maybe [ChannelMembershipSummary]) Source #
The information for the requested channel memberships.
listChannelMembershipsResponse_nextToken :: Lens' ListChannelMembershipsResponse (Maybe Text) Source #
The token passed by previous API calls until all requested channel memberships are returned.
listChannelMembershipsResponse_httpStatus :: Lens' ListChannelMembershipsResponse Int Source #
The response's http status code.
ListChannelMembershipsForAppInstanceUser
listChannelMembershipsForAppInstanceUser_appInstanceUserArn :: Lens' ListChannelMembershipsForAppInstanceUser (Maybe Text) Source #
The ARN of the AppInstanceUsers
listChannelMembershipsForAppInstanceUser_maxResults :: Lens' ListChannelMembershipsForAppInstanceUser (Maybe Natural) Source #
The maximum number of users that you want returned.
listChannelMembershipsForAppInstanceUser_nextToken :: Lens' ListChannelMembershipsForAppInstanceUser (Maybe Text) Source #
The token returned from previous API requests until the number of channel memberships is reached.
listChannelMembershipsForAppInstanceUser_chimeBearer :: Lens' ListChannelMembershipsForAppInstanceUser Text Source #
The AppInstanceUserArn of the user that makes the API call.
listChannelMembershipsForAppInstanceUserResponse_channelMemberships :: Lens' ListChannelMembershipsForAppInstanceUserResponse (Maybe [ChannelMembershipForAppInstanceUserSummary]) Source #
The information for the requested channel memberships.
listChannelMembershipsForAppInstanceUserResponse_nextToken :: Lens' ListChannelMembershipsForAppInstanceUserResponse (Maybe Text) Source #
The token passed by previous API calls until all requested users are returned.
listChannelMembershipsForAppInstanceUserResponse_httpStatus :: Lens' ListChannelMembershipsForAppInstanceUserResponse Int Source #
The response's http status code.
ListChannelMessages
listChannelMessages_maxResults :: Lens' ListChannelMessages (Maybe Natural) Source #
The maximum number of messages that you want returned.
listChannelMessages_nextToken :: Lens' ListChannelMessages (Maybe Text) Source #
The token passed by previous API calls until all requested messages are returned.
listChannelMessages_notAfter :: Lens' ListChannelMessages (Maybe UTCTime) Source #
The final or ending time stamp for your requested messages.
listChannelMessages_notBefore :: Lens' ListChannelMessages (Maybe UTCTime) Source #
The initial or starting time stamp for your requested messages.
listChannelMessages_sortOrder :: Lens' ListChannelMessages (Maybe SortOrder) Source #
The order in which you want messages sorted. Default is Descending, based on time created.
listChannelMessages_subChannelId :: Lens' ListChannelMessages (Maybe Text) Source #
The ID of the SubChannel in the request.
Only required when listing the messages in a SubChannel that the user belongs to.
listChannelMessages_channelArn :: Lens' ListChannelMessages Text Source #
The ARN of the channel.
listChannelMessages_chimeBearer :: Lens' ListChannelMessages Text Source #
The AppInstanceUserArn of the user that makes the API call.
listChannelMessagesResponse_channelArn :: Lens' ListChannelMessagesResponse (Maybe Text) Source #
The ARN of the channel containing the requested messages.
listChannelMessagesResponse_channelMessages :: Lens' ListChannelMessagesResponse (Maybe [ChannelMessageSummary]) Source #
The information about, and content of, each requested message.
listChannelMessagesResponse_nextToken :: Lens' ListChannelMessagesResponse (Maybe Text) Source #
The token passed by previous API calls until all requested messages are returned.
listChannelMessagesResponse_subChannelId :: Lens' ListChannelMessagesResponse (Maybe Text) Source #
The ID of the SubChannel in the response.
listChannelMessagesResponse_httpStatus :: Lens' ListChannelMessagesResponse Int Source #
The response's http status code.
ListChannelModerators
listChannelModerators_maxResults :: Lens' ListChannelModerators (Maybe Natural) Source #
The maximum number of moderators that you want returned.
listChannelModerators_nextToken :: Lens' ListChannelModerators (Maybe Text) Source #
The token passed by previous API calls until all requested moderators are returned.
listChannelModerators_channelArn :: Lens' ListChannelModerators Text Source #
The ARN of the channel.
listChannelModerators_chimeBearer :: Lens' ListChannelModerators Text Source #
The AppInstanceUserArn of the user that makes the API call.
listChannelModeratorsResponse_channelArn :: Lens' ListChannelModeratorsResponse (Maybe Text) Source #
The ARN of the channel.
listChannelModeratorsResponse_channelModerators :: Lens' ListChannelModeratorsResponse (Maybe [ChannelModeratorSummary]) Source #
The information about and names of each moderator.
listChannelModeratorsResponse_nextToken :: Lens' ListChannelModeratorsResponse (Maybe Text) Source #
The token passed by previous API calls until all requested moderators are returned.
listChannelModeratorsResponse_httpStatus :: Lens' ListChannelModeratorsResponse Int Source #
The response's http status code.
ListChannels
listChannels_maxResults :: Lens' ListChannels (Maybe Natural) Source #
The maximum number of channels that you want to return.
listChannels_nextToken :: Lens' ListChannels (Maybe Text) Source #
The token passed by previous API calls until all requested channels are returned.
listChannels_privacy :: Lens' ListChannels (Maybe ChannelPrivacy) Source #
The privacy setting. PUBLIC retrieves all the public channels.
PRIVATE retrieves private channels. Only an AppInstanceAdmin can
retrieve private channels.
listChannels_appInstanceArn :: Lens' ListChannels Text Source #
The ARN of the AppInstance.
listChannels_chimeBearer :: Lens' ListChannels Text Source #
The AppInstanceUserArn of the user that makes the API call.
listChannelsResponse_channels :: Lens' ListChannelsResponse (Maybe [ChannelSummary]) Source #
The information about each channel.
listChannelsResponse_nextToken :: Lens' ListChannelsResponse (Maybe Text) Source #
The token returned from previous API requests until the number of channels is reached.
listChannelsResponse_httpStatus :: Lens' ListChannelsResponse Int Source #
The response's http status code.
ListChannelsAssociatedWithChannelFlow
listChannelsAssociatedWithChannelFlow_maxResults :: Lens' ListChannelsAssociatedWithChannelFlow (Maybe Natural) Source #
The maximum number of channels that you want to return.
listChannelsAssociatedWithChannelFlow_nextToken :: Lens' ListChannelsAssociatedWithChannelFlow (Maybe Text) Source #
The token passed by previous API calls until all requested channels are returned.
listChannelsAssociatedWithChannelFlow_channelFlowArn :: Lens' ListChannelsAssociatedWithChannelFlow Text Source #
The ARN of the channel flow.
listChannelsAssociatedWithChannelFlowResponse_channels :: Lens' ListChannelsAssociatedWithChannelFlowResponse (Maybe [ChannelAssociatedWithFlowSummary]) Source #
The information about each channel.
listChannelsAssociatedWithChannelFlowResponse_nextToken :: Lens' ListChannelsAssociatedWithChannelFlowResponse (Maybe Text) Source #
The token passed by previous API calls until all requested channels are returned.
listChannelsAssociatedWithChannelFlowResponse_httpStatus :: Lens' ListChannelsAssociatedWithChannelFlowResponse Int Source #
The response's http status code.
ListChannelsModeratedByAppInstanceUser
listChannelsModeratedByAppInstanceUser_appInstanceUserArn :: Lens' ListChannelsModeratedByAppInstanceUser (Maybe Text) Source #
The ARN of the user in the moderated channel.
listChannelsModeratedByAppInstanceUser_maxResults :: Lens' ListChannelsModeratedByAppInstanceUser (Maybe Natural) Source #
The maximum number of channels in the request.
listChannelsModeratedByAppInstanceUser_nextToken :: Lens' ListChannelsModeratedByAppInstanceUser (Maybe Text) Source #
The token returned from previous API requests until the number of channels moderated by the user is reached.
listChannelsModeratedByAppInstanceUser_chimeBearer :: Lens' ListChannelsModeratedByAppInstanceUser Text Source #
The AppInstanceUserArn of the user that makes the API call.
listChannelsModeratedByAppInstanceUserResponse_channels :: Lens' ListChannelsModeratedByAppInstanceUserResponse (Maybe [ChannelModeratedByAppInstanceUserSummary]) Source #
The moderated channels in the request.
listChannelsModeratedByAppInstanceUserResponse_nextToken :: Lens' ListChannelsModeratedByAppInstanceUserResponse (Maybe Text) Source #
The token returned from previous API requests until the number of channels moderated by the user is reached.
listChannelsModeratedByAppInstanceUserResponse_httpStatus :: Lens' ListChannelsModeratedByAppInstanceUserResponse Int Source #
The response's http status code.
ListSubChannels
listSubChannels_maxResults :: Lens' ListSubChannels (Maybe Natural) Source #
The maximum number of sub-channels that you want to return.
listSubChannels_nextToken :: Lens' ListSubChannels (Maybe Text) Source #
The token passed by previous API calls until all requested sub-channels are returned.
listSubChannels_channelArn :: Lens' ListSubChannels Text Source #
The ARN of elastic channel.
listSubChannels_chimeBearer :: Lens' ListSubChannels Text Source #
The AppInstanceUserArn of the user making the API call.
listSubChannelsResponse_channelArn :: Lens' ListSubChannelsResponse (Maybe Text) Source #
The ARN of elastic channel.
listSubChannelsResponse_nextToken :: Lens' ListSubChannelsResponse (Maybe Text) Source #
The token passed by previous API calls until all requested sub-channels are returned.
listSubChannelsResponse_subChannels :: Lens' ListSubChannelsResponse (Maybe [SubChannelSummary]) Source #
The information about each sub-channel.
listSubChannelsResponse_httpStatus :: Lens' ListSubChannelsResponse Int Source #
The response's http status code.
ListTagsForResource
listTagsForResource_resourceARN :: Lens' ListTagsForResource Text Source #
The ARN of the resource.
listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (NonEmpty Tag)) Source #
The tag key-value pairs.
listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int Source #
The response's http status code.
PutChannelMembershipPreferences
putChannelMembershipPreferences_channelArn :: Lens' PutChannelMembershipPreferences Text Source #
The ARN of the channel.
putChannelMembershipPreferences_memberArn :: Lens' PutChannelMembershipPreferences Text Source #
The AppInstanceUserArn of the member setting the preferences.
putChannelMembershipPreferences_chimeBearer :: Lens' PutChannelMembershipPreferences Text Source #
The AppInstanceUserARN of the user making the API call.
putChannelMembershipPreferences_preferences :: Lens' PutChannelMembershipPreferences ChannelMembershipPreferences Source #
The channel membership preferences of an AppInstanceUser .
putChannelMembershipPreferencesResponse_channelArn :: Lens' PutChannelMembershipPreferencesResponse (Maybe Text) Source #
The ARN of the channel.
putChannelMembershipPreferencesResponse_member :: Lens' PutChannelMembershipPreferencesResponse (Maybe Identity) Source #
The details of a user.
putChannelMembershipPreferencesResponse_preferences :: Lens' PutChannelMembershipPreferencesResponse (Maybe ChannelMembershipPreferences) Source #
The ARN and metadata of the member being added.
putChannelMembershipPreferencesResponse_httpStatus :: Lens' PutChannelMembershipPreferencesResponse Int Source #
The response's http status code.
RedactChannelMessage
redactChannelMessage_subChannelId :: Lens' RedactChannelMessage (Maybe Text) Source #
The ID of the SubChannel in the request.
redactChannelMessage_channelArn :: Lens' RedactChannelMessage Text Source #
The ARN of the channel containing the messages that you want to redact.
redactChannelMessage_messageId :: Lens' RedactChannelMessage Text Source #
The ID of the message being redacted.
redactChannelMessage_chimeBearer :: Lens' RedactChannelMessage Text Source #
The AppInstanceUserArn of the user that makes the API call.
redactChannelMessageResponse_channelArn :: Lens' RedactChannelMessageResponse (Maybe Text) Source #
The ARN of the channel containing the messages that you want to redact.
redactChannelMessageResponse_messageId :: Lens' RedactChannelMessageResponse (Maybe Text) Source #
The ID of the message being redacted.
redactChannelMessageResponse_subChannelId :: Lens' RedactChannelMessageResponse (Maybe Text) Source #
The ID of the SubChannel in the response.
Only required when redacting messages in a SubChannel that the user belongs to.
redactChannelMessageResponse_httpStatus :: Lens' RedactChannelMessageResponse Int Source #
The response's http status code.
SearchChannels
searchChannels_chimeBearer :: Lens' SearchChannels (Maybe Text) Source #
The AppInstanceUserArn of the user making the API call.
searchChannels_maxResults :: Lens' SearchChannels (Maybe Natural) Source #
The maximum number of channels that you want returned.
searchChannels_nextToken :: Lens' SearchChannels (Maybe Text) Source #
The token returned from previous API requests until the number of channels is reached.
searchChannels_fields :: Lens' SearchChannels (NonEmpty SearchField) Source #
A list of the Field objects in the channel being searched.
searchChannelsResponse_channels :: Lens' SearchChannelsResponse (Maybe [ChannelSummary]) Source #
A list of the channels in the request.
searchChannelsResponse_nextToken :: Lens' SearchChannelsResponse (Maybe Text) Source #
The token returned from previous API responses until the number of channels is reached.
searchChannelsResponse_httpStatus :: Lens' SearchChannelsResponse Int Source #
The response's http status code.
SendChannelMessage
sendChannelMessage_messageAttributes :: Lens' SendChannelMessage (Maybe (HashMap Text MessageAttributeValue)) Source #
The attributes for the message, used for message filtering along with a
FilterRule defined in the PushNotificationPreferences.
sendChannelMessage_metadata :: Lens' SendChannelMessage (Maybe Text) Source #
The optional metadata for each message.
sendChannelMessage_pushNotification :: Lens' SendChannelMessage (Maybe PushNotificationConfiguration) Source #
The push notification configuration of the message.
sendChannelMessage_subChannelId :: Lens' SendChannelMessage (Maybe Text) Source #
The ID of the SubChannel in the request.
sendChannelMessage_channelArn :: Lens' SendChannelMessage Text Source #
The ARN of the channel.
sendChannelMessage_content :: Lens' SendChannelMessage Text Source #
The content of the message.
sendChannelMessage_type :: Lens' SendChannelMessage ChannelMessageType Source #
The type of message, STANDARD or CONTROL.
sendChannelMessage_persistence :: Lens' SendChannelMessage ChannelMessagePersistenceType Source #
Boolean that controls whether the message is persisted on the back end. Required.
sendChannelMessage_clientRequestToken :: Lens' SendChannelMessage Text Source #
The Idempotency token for each client request.
sendChannelMessage_chimeBearer :: Lens' SendChannelMessage Text Source #
The AppInstanceUserArn of the user that makes the API call.
sendChannelMessageResponse_channelArn :: Lens' SendChannelMessageResponse (Maybe Text) Source #
The ARN of the channel.
sendChannelMessageResponse_messageId :: Lens' SendChannelMessageResponse (Maybe Text) Source #
The ID string assigned to each message.
sendChannelMessageResponse_status :: Lens' SendChannelMessageResponse (Maybe ChannelMessageStatusStructure) Source #
The status of the channel message.
sendChannelMessageResponse_subChannelId :: Lens' SendChannelMessageResponse (Maybe Text) Source #
The ID of the SubChannel in the response.
sendChannelMessageResponse_httpStatus :: Lens' SendChannelMessageResponse Int Source #
The response's http status code.
TagResource
tagResource_resourceARN :: Lens' TagResource Text Source #
The resource ARN.
tagResource_tags :: Lens' TagResource (NonEmpty Tag) Source #
The tag key-value pairs.
UntagResource
untagResource_resourceARN :: Lens' UntagResource Text Source #
The resource ARN.
untagResource_tagKeys :: Lens' UntagResource (NonEmpty Text) Source #
The tag keys.
UpdateChannel
updateChannel_metadata :: Lens' UpdateChannel (Maybe Text) Source #
The metadata for the update request.
updateChannel_mode :: Lens' UpdateChannel (Maybe ChannelMode) Source #
The mode of the update request.
updateChannel_name :: Lens' UpdateChannel (Maybe Text) Source #
The name of the channel.
updateChannel_channelArn :: Lens' UpdateChannel Text Source #
The ARN of the channel.
updateChannel_chimeBearer :: Lens' UpdateChannel Text Source #
The AppInstanceUserArn of the user that makes the API call.
updateChannelResponse_channelArn :: Lens' UpdateChannelResponse (Maybe Text) Source #
The ARN of the channel.
updateChannelResponse_httpStatus :: Lens' UpdateChannelResponse Int Source #
The response's http status code.
UpdateChannelFlow
updateChannelFlow_channelFlowArn :: Lens' UpdateChannelFlow Text Source #
The ARN of the channel flow.
updateChannelFlow_processors :: Lens' UpdateChannelFlow (NonEmpty Processor) Source #
Information about the processor Lambda functions
updateChannelFlow_name :: Lens' UpdateChannelFlow Text Source #
The name of the channel flow.
updateChannelFlowResponse_channelFlowArn :: Lens' UpdateChannelFlowResponse (Maybe Text) Source #
The ARN of the channel flow.
updateChannelFlowResponse_httpStatus :: Lens' UpdateChannelFlowResponse Int Source #
The response's http status code.
UpdateChannelMessage
updateChannelMessage_content :: Lens' UpdateChannelMessage (Maybe Text) Source #
The content of the message being updated.
updateChannelMessage_metadata :: Lens' UpdateChannelMessage (Maybe Text) Source #
The metadata of the message being updated.
updateChannelMessage_subChannelId :: Lens' UpdateChannelMessage (Maybe Text) Source #
The ID of the SubChannel in the request.
Only required when updating messages in a SubChannel that the user belongs to.
updateChannelMessage_channelArn :: Lens' UpdateChannelMessage Text Source #
The ARN of the channel.
updateChannelMessage_messageId :: Lens' UpdateChannelMessage Text Source #
The ID string of the message being updated.
updateChannelMessage_chimeBearer :: Lens' UpdateChannelMessage Text Source #
The AppInstanceUserArn of the user that makes the API call.
updateChannelMessageResponse_channelArn :: Lens' UpdateChannelMessageResponse (Maybe Text) Source #
The ARN of the channel.
updateChannelMessageResponse_messageId :: Lens' UpdateChannelMessageResponse (Maybe Text) Source #
The ID string of the message being updated.
updateChannelMessageResponse_status :: Lens' UpdateChannelMessageResponse (Maybe ChannelMessageStatusStructure) Source #
The status of the message update.
updateChannelMessageResponse_subChannelId :: Lens' UpdateChannelMessageResponse (Maybe Text) Source #
The ID of the SubChannel in the response.
updateChannelMessageResponse_httpStatus :: Lens' UpdateChannelMessageResponse Int Source #
The response's http status code.
UpdateChannelReadMarker
updateChannelReadMarker_subChannelId :: Lens' UpdateChannelReadMarker (Maybe Text) Source #
The ID of the SubChannel in the request.
updateChannelReadMarker_channelArn :: Lens' UpdateChannelReadMarker Text Source #
The ARN of the channel.
updateChannelReadMarker_chimeBearer :: Lens' UpdateChannelReadMarker Text Source #
The AppInstanceUserArn of the user that makes the API call.
updateChannelReadMarkerResponse_channelArn :: Lens' UpdateChannelReadMarkerResponse (Maybe Text) Source #
The ARN of the channel.
updateChannelReadMarkerResponse_subChannelId :: Lens' UpdateChannelReadMarkerResponse (Maybe Text) Source #
The ID of the SubChannel in the response.
updateChannelReadMarkerResponse_httpStatus :: Lens' UpdateChannelReadMarkerResponse Int Source #
The response's http status code.
Types
AppInstanceUserMembershipSummary
appInstanceUserMembershipSummary_readMarkerTimestamp :: Lens' AppInstanceUserMembershipSummary (Maybe UTCTime) Source #
The time at which an AppInstanceUser last marked a channel as read.
appInstanceUserMembershipSummary_subChannelId :: Lens' AppInstanceUserMembershipSummary (Maybe Text) Source #
The ID of the SubChannel that the AppInstanceUser is a member of.
appInstanceUserMembershipSummary_type :: Lens' AppInstanceUserMembershipSummary (Maybe ChannelMembershipType) Source #
The type of ChannelMembership.
BatchChannelMemberships
batchChannelMemberships_channelArn :: Lens' BatchChannelMemberships (Maybe Text) Source #
The ARN of the channel to which you're adding users.
batchChannelMemberships_invitedBy :: Lens' BatchChannelMemberships (Maybe Identity) Source #
The identifier of the member who invited another member.
batchChannelMemberships_members :: Lens' BatchChannelMemberships (Maybe [Identity]) Source #
The users successfully added to the request.
batchChannelMemberships_subChannelId :: Lens' BatchChannelMemberships (Maybe Text) Source #
The ID of the SubChannel.
batchChannelMemberships_type :: Lens' BatchChannelMemberships (Maybe ChannelMembershipType) Source #
The membership types set for the channel users.
BatchCreateChannelMembershipError
batchCreateChannelMembershipError_errorCode :: Lens' BatchCreateChannelMembershipError (Maybe ErrorCode) Source #
The error code.
batchCreateChannelMembershipError_errorMessage :: Lens' BatchCreateChannelMembershipError (Maybe Text) Source #
The error message.
batchCreateChannelMembershipError_memberArn :: Lens' BatchCreateChannelMembershipError (Maybe Text) Source #
The AppInstanceUserArn of the member that the service couldn't add.
Channel
channel_createdBy :: Lens' Channel (Maybe Identity) Source #
The AppInstanceUser who created the channel.
channel_createdTimestamp :: Lens' Channel (Maybe UTCTime) Source #
The time at which the AppInstanceUser created the channel.
channel_elasticChannelConfiguration :: Lens' Channel (Maybe ElasticChannelConfiguration) Source #
The attributes required to configure and create an elastic channel. An elastic channel can support a maximum of 1-million members.
channel_lastMessageTimestamp :: Lens' Channel (Maybe UTCTime) Source #
The time at which a member sent the last message in the channel.
channel_lastUpdatedTimestamp :: Lens' Channel (Maybe UTCTime) Source #
The time at which a channel was last updated.
channel_mode :: Lens' Channel (Maybe ChannelMode) Source #
The mode of the channel.
channel_privacy :: Lens' Channel (Maybe ChannelPrivacy) Source #
The channel's privacy setting.
ChannelAssociatedWithFlowSummary
channelAssociatedWithFlowSummary_channelArn :: Lens' ChannelAssociatedWithFlowSummary (Maybe Text) Source #
The ARN of the channel.
channelAssociatedWithFlowSummary_metadata :: Lens' ChannelAssociatedWithFlowSummary (Maybe Text) Source #
The channel's metadata.
channelAssociatedWithFlowSummary_mode :: Lens' ChannelAssociatedWithFlowSummary (Maybe ChannelMode) Source #
The mode of the channel.
channelAssociatedWithFlowSummary_name :: Lens' ChannelAssociatedWithFlowSummary (Maybe Text) Source #
The name of the channel flow.
channelAssociatedWithFlowSummary_privacy :: Lens' ChannelAssociatedWithFlowSummary (Maybe ChannelPrivacy) Source #
The channel's privacy setting.
ChannelBan
channelBan_channelArn :: Lens' ChannelBan (Maybe Text) Source #
The ARN of the channel from which a member is being banned.
channelBan_createdBy :: Lens' ChannelBan (Maybe Identity) Source #
The AppInstanceUser who created the ban.
channelBan_createdTimestamp :: Lens' ChannelBan (Maybe UTCTime) Source #
The time at which the ban was created.
channelBan_member :: Lens' ChannelBan (Maybe Identity) Source #
The member being banned from the channel.
ChannelBanSummary
channelBanSummary_member :: Lens' ChannelBanSummary (Maybe Identity) Source #
The member being banned from a channel.
ChannelFlow
channelFlow_channelFlowArn :: Lens' ChannelFlow (Maybe Text) Source #
The ARN of the channel flow.
channelFlow_createdTimestamp :: Lens' ChannelFlow (Maybe UTCTime) Source #
The time at which the channel flow was created.
channelFlow_lastUpdatedTimestamp :: Lens' ChannelFlow (Maybe UTCTime) Source #
The time at which a channel flow was updated.
channelFlow_name :: Lens' ChannelFlow (Maybe Text) Source #
The name of the channel flow.
channelFlow_processors :: Lens' ChannelFlow (Maybe (NonEmpty Processor)) Source #
Information about the processor Lambda functions.
ChannelFlowSummary
channelFlowSummary_channelFlowArn :: Lens' ChannelFlowSummary (Maybe Text) Source #
The ARN of the channel flow.
channelFlowSummary_name :: Lens' ChannelFlowSummary (Maybe Text) Source #
The name of the channel flow.
channelFlowSummary_processors :: Lens' ChannelFlowSummary (Maybe (NonEmpty Processor)) Source #
Information about the processor Lambda functions.
ChannelMembership
channelMembership_channelArn :: Lens' ChannelMembership (Maybe Text) Source #
The ARN of the member's channel.
channelMembership_createdTimestamp :: Lens' ChannelMembership (Maybe UTCTime) Source #
The time at which the channel membership was created.
channelMembership_invitedBy :: Lens' ChannelMembership (Maybe Identity) Source #
The identifier of the member who invited another member.
channelMembership_lastUpdatedTimestamp :: Lens' ChannelMembership (Maybe UTCTime) Source #
The time at which a channel membership was last updated.
channelMembership_member :: Lens' ChannelMembership (Maybe Identity) Source #
The data of the channel member.
channelMembership_subChannelId :: Lens' ChannelMembership (Maybe Text) Source #
The ID of the SubChannel that a user belongs to.
channelMembership_type :: Lens' ChannelMembership (Maybe ChannelMembershipType) Source #
The membership type set for the channel member.
ChannelMembershipForAppInstanceUserSummary
channelMembershipForAppInstanceUserSummary_appInstanceUserMembershipSummary :: Lens' ChannelMembershipForAppInstanceUserSummary (Maybe AppInstanceUserMembershipSummary) Source #
Returns the channel membership data for an AppInstance.
channelMembershipForAppInstanceUserSummary_channelSummary :: Lens' ChannelMembershipForAppInstanceUserSummary (Maybe ChannelSummary) Source #
Returns the channel data for an AppInstance.
ChannelMembershipPreferences
channelMembershipPreferences_pushNotifications :: Lens' ChannelMembershipPreferences (Maybe PushNotificationPreferences) Source #
The push notification configuration of a message.
ChannelMembershipSummary
channelMembershipSummary_member :: Lens' ChannelMembershipSummary (Maybe Identity) Source #
A member's summary data.
ChannelMessage
channelMessage_channelArn :: Lens' ChannelMessage (Maybe Text) Source #
The ARN of the channel.
channelMessage_content :: Lens' ChannelMessage (Maybe Text) Source #
The message content.
channelMessage_createdTimestamp :: Lens' ChannelMessage (Maybe UTCTime) Source #
The time at which the message was created.
channelMessage_lastEditedTimestamp :: Lens' ChannelMessage (Maybe UTCTime) Source #
The time at which a message was edited.
channelMessage_lastUpdatedTimestamp :: Lens' ChannelMessage (Maybe UTCTime) Source #
The time at which a message was updated.
channelMessage_messageAttributes :: Lens' ChannelMessage (Maybe (HashMap Text MessageAttributeValue)) Source #
The attributes for the message, used for message filtering along with a
FilterRule defined in the PushNotificationPreferences.
channelMessage_messageId :: Lens' ChannelMessage (Maybe Text) Source #
The ID of a message.
channelMessage_metadata :: Lens' ChannelMessage (Maybe Text) Source #
The message metadata.
channelMessage_persistence :: Lens' ChannelMessage (Maybe ChannelMessagePersistenceType) Source #
The persistence setting for a channel message.
channelMessage_redacted :: Lens' ChannelMessage (Maybe Bool) Source #
Hides the content of a message.
channelMessage_sender :: Lens' ChannelMessage (Maybe Identity) Source #
The message sender.
channelMessage_status :: Lens' ChannelMessage (Maybe ChannelMessageStatusStructure) Source #
The status of the channel message.
channelMessage_subChannelId :: Lens' ChannelMessage (Maybe Text) Source #
The ID of the SubChannel.
channelMessage_type :: Lens' ChannelMessage (Maybe ChannelMessageType) Source #
The message type.
ChannelMessageCallback
channelMessageCallback_content :: Lens' ChannelMessageCallback (Maybe Text) Source #
The message content.
channelMessageCallback_messageAttributes :: Lens' ChannelMessageCallback (Maybe (HashMap Text MessageAttributeValue)) Source #
The attributes for the message, used for message filtering along with a
FilterRule defined in the PushNotificationPreferences.
channelMessageCallback_metadata :: Lens' ChannelMessageCallback (Maybe Text) Source #
The message metadata.
channelMessageCallback_pushNotification :: Lens' ChannelMessageCallback (Maybe PushNotificationConfiguration) Source #
The push notification configuration of the message.
channelMessageCallback_subChannelId :: Lens' ChannelMessageCallback (Maybe Text) Source #
The ID of the SubChannel.
channelMessageCallback_messageId :: Lens' ChannelMessageCallback Text Source #
The message ID.
ChannelMessageStatusStructure
channelMessageStatusStructure_detail :: Lens' ChannelMessageStatusStructure (Maybe Text) Source #
Contains more details about the messasge status.
channelMessageStatusStructure_value :: Lens' ChannelMessageStatusStructure (Maybe ChannelMessageStatus) Source #
The message status value.
ChannelMessageSummary
channelMessageSummary_content :: Lens' ChannelMessageSummary (Maybe Text) Source #
The content of the message.
channelMessageSummary_createdTimestamp :: Lens' ChannelMessageSummary (Maybe UTCTime) Source #
The time at which the message summary was created.
channelMessageSummary_lastEditedTimestamp :: Lens' ChannelMessageSummary (Maybe UTCTime) Source #
The time at which a message was last edited.
channelMessageSummary_lastUpdatedTimestamp :: Lens' ChannelMessageSummary (Maybe UTCTime) Source #
The time at which a message was last updated.
channelMessageSummary_messageAttributes :: Lens' ChannelMessageSummary (Maybe (HashMap Text MessageAttributeValue)) Source #
The message attribues listed in a the summary of a channel message.
channelMessageSummary_messageId :: Lens' ChannelMessageSummary (Maybe Text) Source #
The ID of the message.
channelMessageSummary_metadata :: Lens' ChannelMessageSummary (Maybe Text) Source #
The metadata of the message.
channelMessageSummary_redacted :: Lens' ChannelMessageSummary (Maybe Bool) Source #
Indicates whether a message was redacted.
channelMessageSummary_sender :: Lens' ChannelMessageSummary (Maybe Identity) Source #
The message sender.
channelMessageSummary_status :: Lens' ChannelMessageSummary (Maybe ChannelMessageStatusStructure) Source #
The message status. The status value is SENT for messages sent to a
channel without a channel flow. For channels associated with channel
flow, the value determines the processing stage.
channelMessageSummary_type :: Lens' ChannelMessageSummary (Maybe ChannelMessageType) Source #
The type of message.
ChannelModeratedByAppInstanceUserSummary
channelModeratedByAppInstanceUserSummary_channelSummary :: Lens' ChannelModeratedByAppInstanceUserSummary (Maybe ChannelSummary) Source #
Summary of the details of a Channel.
ChannelModerator
channelModerator_channelArn :: Lens' ChannelModerator (Maybe Text) Source #
The ARN of the moderator's channel.
channelModerator_createdBy :: Lens' ChannelModerator (Maybe Identity) Source #
The AppInstanceUser who created the moderator.
channelModerator_createdTimestamp :: Lens' ChannelModerator (Maybe UTCTime) Source #
The time at which the moderator was created.
channelModerator_moderator :: Lens' ChannelModerator (Maybe Identity) Source #
The moderator's data.
ChannelModeratorSummary
channelModeratorSummary_moderator :: Lens' ChannelModeratorSummary (Maybe Identity) Source #
The data for a moderator.
ChannelSummary
channelSummary_channelArn :: Lens' ChannelSummary (Maybe Text) Source #
The ARN of the channel.
channelSummary_lastMessageTimestamp :: Lens' ChannelSummary (Maybe UTCTime) Source #
The time at which the last persistent message in a channel was sent.
channelSummary_metadata :: Lens' ChannelSummary (Maybe Text) Source #
The metadata of the channel.
channelSummary_mode :: Lens' ChannelSummary (Maybe ChannelMode) Source #
The mode of the channel.
channelSummary_name :: Lens' ChannelSummary (Maybe Text) Source #
The name of the channel.
channelSummary_privacy :: Lens' ChannelSummary (Maybe ChannelPrivacy) Source #
The privacy setting of the channel.
ElasticChannelConfiguration
elasticChannelConfiguration_maximumSubChannels :: Lens' ElasticChannelConfiguration Natural Source #
The maximum number of SubChannels that you want to allow in the elastic channel.
elasticChannelConfiguration_targetMembershipsPerSubChannel :: Lens' ElasticChannelConfiguration Natural Source #
The maximum number of members allowed in a SubChannel.
elasticChannelConfiguration_minimumMembershipPercentage :: Lens' ElasticChannelConfiguration Natural Source #
The minimum allowed percentage of TargetMembershipsPerSubChannel users. Ceil of the calculated value is used in balancing members among SubChannels of the elastic channel.
Identity
LambdaConfiguration
lambdaConfiguration_resourceArn :: Lens' LambdaConfiguration Text Source #
The ARN of the Lambda message processing function.
lambdaConfiguration_invocationType :: Lens' LambdaConfiguration InvocationType Source #
Controls how the Lambda function is invoked.
MessageAttributeValue
messageAttributeValue_stringValues :: Lens' MessageAttributeValue (Maybe [Text]) Source #
The strings in a message attribute value.
MessagingSessionEndpoint
messagingSessionEndpoint_url :: Lens' MessagingSessionEndpoint (Maybe Text) Source #
The endpoint to which you establish a websocket connection.
Processor
processor_configuration :: Lens' Processor ProcessorConfiguration Source #
The information about the type of processor and its identifier.
processor_executionOrder :: Lens' Processor Natural Source #
The sequence in which processors run. If you have multiple processors in a channel flow, message processing goes through each processor in the sequence. The value determines the sequence. At this point, we support only 1 processor within a flow.
processor_fallbackAction :: Lens' Processor FallbackAction Source #
Determines whether to continue with message processing or stop it in
cases where communication with a processor fails. If a processor has a
fallback action of ABORT and communication with it fails, the
processor sets the message status to FAILED and does not send the
message to any recipients. Note that if the last processor in the
channel flow sequence has a fallback action of CONTINUE and
communication with the processor fails, then the message is considered
processed and sent to recipients of the channel.
ProcessorConfiguration
processorConfiguration_lambda :: Lens' ProcessorConfiguration LambdaConfiguration Source #
Indicates that the processor is of type Lambda.
PushNotificationConfiguration
pushNotificationConfiguration_body :: Lens' PushNotificationConfiguration (Maybe Text) Source #
The body of the push notification.
pushNotificationConfiguration_title :: Lens' PushNotificationConfiguration (Maybe Text) Source #
The title of the push notification.
pushNotificationConfiguration_type :: Lens' PushNotificationConfiguration (Maybe PushNotificationType) Source #
Enum value that indicates the type of the push notification for a
message. DEFAULT: Normal mobile push notification. VOIP: VOIP mobile
push notification.
PushNotificationPreferences
pushNotificationPreferences_filterRule :: Lens' PushNotificationPreferences (Maybe Text) Source #
The simple JSON object used to send a subset of a push notification to the requested member.
pushNotificationPreferences_allowNotifications :: Lens' PushNotificationPreferences AllowNotifications Source #
Enum value that indicates which push notifications to send to the
requested member of a channel. ALL sends all push notifications,
NONE sends no push notifications, FILTERED sends only filtered push
notifications.
SearchField
searchField_key :: Lens' SearchField SearchFieldKey Source #
An enum value that indicates the key to search the channel on.
MEMBERS allows you to search channels based on memberships. You can
use it with the EQUALS operator to get channels whose memberships are
equal to the specified values, and with the INCLUDES operator to get
channels whose memberships include the specified values.
searchField_values :: Lens' SearchField (NonEmpty Text) Source #
The values that you want to search for, a list of strings. The values
must be AppInstanceUserArns specified as a list of strings.
This operation isn't supported for AppInstanceUsers with large number
of memberships.
searchField_operator :: Lens' SearchField SearchFieldOperator Source #
The operator used to compare field values, currently EQUALS or
INCLUDES. Use the EQUALS operator to find channels whose memberships
equal the specified values. Use the INCLUDES operator to find channels
whose memberships include the specified values.
SubChannelSummary
subChannelSummary_membershipCount :: Lens' SubChannelSummary (Maybe Int) Source #
The number of members in a SubChannel.
subChannelSummary_subChannelId :: Lens' SubChannelSummary (Maybe Text) Source #
The unique ID of a SubChannel.