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 |
- Service Configuration
- Errors
- Waiters
- 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
- AllowNotifications
- ChannelMembershipType
- ChannelMessagePersistenceType
- ChannelMessageStatus
- ChannelMessageType
- ChannelMode
- ChannelPrivacy
- ErrorCode
- FallbackAction
- InvocationType
- PushNotificationType
- SearchFieldKey
- SearchFieldOperator
- SortOrder
- 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
Derived from API version 2021-05-15
of the AWS service descriptions, licensed under Apache 2.0.
The Amazon Chime SDK Messaging APIs in this section allow software developers to send and receive messages in custom messaging applications. These APIs depend on the frameworks provided by the Amazon Chime SDK Identity APIs. For more information about the messaging APIs, see Amazon Chime SDK messaging.
Synopsis
- defaultService :: Service
- _BadRequestException :: AsError a => Fold a ServiceError
- _ConflictException :: AsError a => Fold a ServiceError
- _ForbiddenException :: AsError a => Fold a ServiceError
- _NotFoundException :: AsError a => Fold a ServiceError
- _ResourceLimitExceededException :: AsError a => Fold a ServiceError
- _ServiceFailureException :: AsError a => Fold a ServiceError
- _ServiceUnavailableException :: AsError a => Fold a ServiceError
- _ThrottledClientException :: AsError a => Fold a ServiceError
- _UnauthorizedClientException :: AsError a => Fold a ServiceError
- data AssociateChannelFlow = AssociateChannelFlow' Text Text Text
- newAssociateChannelFlow :: Text -> Text -> Text -> AssociateChannelFlow
- data AssociateChannelFlowResponse = AssociateChannelFlowResponse' {
- newAssociateChannelFlowResponse :: AssociateChannelFlowResponse
- data BatchCreateChannelMembership = BatchCreateChannelMembership' (Maybe Text) (Maybe ChannelMembershipType) Text (NonEmpty Text) Text
- newBatchCreateChannelMembership :: Text -> NonEmpty Text -> Text -> BatchCreateChannelMembership
- data BatchCreateChannelMembershipResponse = BatchCreateChannelMembershipResponse' (Maybe BatchChannelMemberships) (Maybe [BatchCreateChannelMembershipError]) Int
- newBatchCreateChannelMembershipResponse :: Int -> BatchCreateChannelMembershipResponse
- data ChannelFlowCallback = ChannelFlowCallback' (Maybe Bool) Text Text ChannelMessageCallback
- newChannelFlowCallback :: Text -> Text -> ChannelMessageCallback -> ChannelFlowCallback
- data ChannelFlowCallbackResponse = ChannelFlowCallbackResponse' (Maybe Text) (Maybe Text) Int
- newChannelFlowCallbackResponse :: Int -> ChannelFlowCallbackResponse
- data CreateChannel = CreateChannel' (Maybe (Sensitive Text)) (Maybe ElasticChannelConfiguration) (Maybe (NonEmpty Text)) (Maybe (Sensitive Text)) (Maybe ChannelMode) (Maybe (NonEmpty Text)) (Maybe ChannelPrivacy) (Maybe (NonEmpty Tag)) Text (Sensitive Text) (Sensitive Text) Text
- newCreateChannel :: Text -> Text -> Text -> Text -> CreateChannel
- data CreateChannelResponse = CreateChannelResponse' (Maybe Text) Int
- newCreateChannelResponse :: Int -> CreateChannelResponse
- data CreateChannelBan = CreateChannelBan' Text Text Text
- newCreateChannelBan :: Text -> Text -> Text -> CreateChannelBan
- data CreateChannelBanResponse = CreateChannelBanResponse' (Maybe Text) (Maybe Identity) Int
- newCreateChannelBanResponse :: Int -> CreateChannelBanResponse
- data CreateChannelFlow = CreateChannelFlow' (Maybe (NonEmpty Tag)) Text (NonEmpty Processor) (Sensitive Text) (Sensitive Text)
- newCreateChannelFlow :: Text -> NonEmpty Processor -> Text -> Text -> CreateChannelFlow
- data CreateChannelFlowResponse = CreateChannelFlowResponse' (Maybe Text) Int
- newCreateChannelFlowResponse :: Int -> CreateChannelFlowResponse
- data CreateChannelMembership = CreateChannelMembership' (Maybe Text) Text Text ChannelMembershipType Text
- newCreateChannelMembership :: Text -> Text -> ChannelMembershipType -> Text -> CreateChannelMembership
- data CreateChannelMembershipResponse = CreateChannelMembershipResponse' (Maybe Text) (Maybe Identity) (Maybe Text) Int
- newCreateChannelMembershipResponse :: Int -> CreateChannelMembershipResponse
- data CreateChannelModerator = CreateChannelModerator' Text Text Text
- newCreateChannelModerator :: Text -> Text -> Text -> CreateChannelModerator
- data CreateChannelModeratorResponse = CreateChannelModeratorResponse' (Maybe Text) (Maybe Identity) Int
- newCreateChannelModeratorResponse :: Int -> CreateChannelModeratorResponse
- data DeleteChannel = DeleteChannel' (Maybe Text) Text Text
- newDeleteChannel :: Text -> Text -> DeleteChannel
- data DeleteChannelResponse = DeleteChannelResponse' {
- newDeleteChannelResponse :: DeleteChannelResponse
- data DeleteChannelBan = DeleteChannelBan' Text Text Text
- newDeleteChannelBan :: Text -> Text -> Text -> DeleteChannelBan
- data DeleteChannelBanResponse = DeleteChannelBanResponse' {
- newDeleteChannelBanResponse :: DeleteChannelBanResponse
- data DeleteChannelFlow = DeleteChannelFlow' Text
- newDeleteChannelFlow :: Text -> DeleteChannelFlow
- data DeleteChannelFlowResponse = DeleteChannelFlowResponse' {
- newDeleteChannelFlowResponse :: DeleteChannelFlowResponse
- data DeleteChannelMembership = DeleteChannelMembership' (Maybe Text) Text Text Text
- newDeleteChannelMembership :: Text -> Text -> Text -> DeleteChannelMembership
- data DeleteChannelMembershipResponse = DeleteChannelMembershipResponse' {
- newDeleteChannelMembershipResponse :: DeleteChannelMembershipResponse
- data DeleteChannelMessage = DeleteChannelMessage' (Maybe Text) Text Text Text
- newDeleteChannelMessage :: Text -> Text -> Text -> DeleteChannelMessage
- data DeleteChannelMessageResponse = DeleteChannelMessageResponse' {
- newDeleteChannelMessageResponse :: DeleteChannelMessageResponse
- data DeleteChannelModerator = DeleteChannelModerator' Text Text Text
- newDeleteChannelModerator :: Text -> Text -> Text -> DeleteChannelModerator
- data DeleteChannelModeratorResponse = DeleteChannelModeratorResponse' {
- newDeleteChannelModeratorResponse :: DeleteChannelModeratorResponse
- data DescribeChannel = DescribeChannel' Text Text
- newDescribeChannel :: Text -> Text -> DescribeChannel
- data DescribeChannelResponse = DescribeChannelResponse' (Maybe Channel) Int
- newDescribeChannelResponse :: Int -> DescribeChannelResponse
- data DescribeChannelBan = DescribeChannelBan' Text Text Text
- newDescribeChannelBan :: Text -> Text -> Text -> DescribeChannelBan
- data DescribeChannelBanResponse = DescribeChannelBanResponse' (Maybe ChannelBan) Int
- newDescribeChannelBanResponse :: Int -> DescribeChannelBanResponse
- data DescribeChannelFlow = DescribeChannelFlow' Text
- newDescribeChannelFlow :: Text -> DescribeChannelFlow
- data DescribeChannelFlowResponse = DescribeChannelFlowResponse' (Maybe ChannelFlow) Int
- newDescribeChannelFlowResponse :: Int -> DescribeChannelFlowResponse
- data DescribeChannelMembership = DescribeChannelMembership' (Maybe Text) Text Text Text
- newDescribeChannelMembership :: Text -> Text -> Text -> DescribeChannelMembership
- data DescribeChannelMembershipResponse = DescribeChannelMembershipResponse' (Maybe ChannelMembership) Int
- newDescribeChannelMembershipResponse :: Int -> DescribeChannelMembershipResponse
- data DescribeChannelMembershipForAppInstanceUser = DescribeChannelMembershipForAppInstanceUser' Text Text Text
- newDescribeChannelMembershipForAppInstanceUser :: Text -> Text -> Text -> DescribeChannelMembershipForAppInstanceUser
- data DescribeChannelMembershipForAppInstanceUserResponse = DescribeChannelMembershipForAppInstanceUserResponse' (Maybe ChannelMembershipForAppInstanceUserSummary) Int
- newDescribeChannelMembershipForAppInstanceUserResponse :: Int -> DescribeChannelMembershipForAppInstanceUserResponse
- data DescribeChannelModeratedByAppInstanceUser = DescribeChannelModeratedByAppInstanceUser' Text Text Text
- newDescribeChannelModeratedByAppInstanceUser :: Text -> Text -> Text -> DescribeChannelModeratedByAppInstanceUser
- data DescribeChannelModeratedByAppInstanceUserResponse = DescribeChannelModeratedByAppInstanceUserResponse' (Maybe ChannelModeratedByAppInstanceUserSummary) Int
- newDescribeChannelModeratedByAppInstanceUserResponse :: Int -> DescribeChannelModeratedByAppInstanceUserResponse
- data DescribeChannelModerator = DescribeChannelModerator' Text Text Text
- newDescribeChannelModerator :: Text -> Text -> Text -> DescribeChannelModerator
- data DescribeChannelModeratorResponse = DescribeChannelModeratorResponse' (Maybe ChannelModerator) Int
- newDescribeChannelModeratorResponse :: Int -> DescribeChannelModeratorResponse
- data DisassociateChannelFlow = DisassociateChannelFlow' Text Text Text
- newDisassociateChannelFlow :: Text -> Text -> Text -> DisassociateChannelFlow
- data DisassociateChannelFlowResponse = DisassociateChannelFlowResponse' {
- newDisassociateChannelFlowResponse :: DisassociateChannelFlowResponse
- data GetChannelMembershipPreferences = GetChannelMembershipPreferences' Text Text Text
- newGetChannelMembershipPreferences :: Text -> Text -> Text -> GetChannelMembershipPreferences
- data GetChannelMembershipPreferencesResponse = GetChannelMembershipPreferencesResponse' (Maybe Text) (Maybe Identity) (Maybe ChannelMembershipPreferences) Int
- newGetChannelMembershipPreferencesResponse :: Int -> GetChannelMembershipPreferencesResponse
- data GetChannelMessage = GetChannelMessage' (Maybe Text) Text Text Text
- newGetChannelMessage :: Text -> Text -> Text -> GetChannelMessage
- data GetChannelMessageResponse = GetChannelMessageResponse' (Maybe ChannelMessage) Int
- newGetChannelMessageResponse :: Int -> GetChannelMessageResponse
- data GetChannelMessageStatus = GetChannelMessageStatus' (Maybe Text) Text Text Text
- newGetChannelMessageStatus :: Text -> Text -> Text -> GetChannelMessageStatus
- data GetChannelMessageStatusResponse = GetChannelMessageStatusResponse' (Maybe ChannelMessageStatusStructure) Int
- newGetChannelMessageStatusResponse :: Int -> GetChannelMessageStatusResponse
- data GetMessagingSessionEndpoint = GetMessagingSessionEndpoint' {
- newGetMessagingSessionEndpoint :: GetMessagingSessionEndpoint
- data GetMessagingSessionEndpointResponse = GetMessagingSessionEndpointResponse' (Maybe MessagingSessionEndpoint) Int
- newGetMessagingSessionEndpointResponse :: Int -> GetMessagingSessionEndpointResponse
- data ListChannelBans = ListChannelBans' (Maybe Natural) (Maybe (Sensitive Text)) Text Text
- newListChannelBans :: Text -> Text -> ListChannelBans
- data ListChannelBansResponse = ListChannelBansResponse' (Maybe Text) (Maybe [ChannelBanSummary]) (Maybe (Sensitive Text)) Int
- newListChannelBansResponse :: Int -> ListChannelBansResponse
- data ListChannelFlows = ListChannelFlows' (Maybe Natural) (Maybe (Sensitive Text)) Text
- newListChannelFlows :: Text -> ListChannelFlows
- data ListChannelFlowsResponse = ListChannelFlowsResponse' (Maybe [ChannelFlowSummary]) (Maybe (Sensitive Text)) Int
- newListChannelFlowsResponse :: Int -> ListChannelFlowsResponse
- data ListChannelMemberships = ListChannelMemberships' (Maybe Natural) (Maybe (Sensitive Text)) (Maybe Text) (Maybe ChannelMembershipType) Text Text
- newListChannelMemberships :: Text -> Text -> ListChannelMemberships
- data ListChannelMembershipsResponse = ListChannelMembershipsResponse' (Maybe Text) (Maybe [ChannelMembershipSummary]) (Maybe (Sensitive Text)) Int
- newListChannelMembershipsResponse :: Int -> ListChannelMembershipsResponse
- data ListChannelMembershipsForAppInstanceUser = ListChannelMembershipsForAppInstanceUser' (Maybe Text) (Maybe Natural) (Maybe (Sensitive Text)) Text
- newListChannelMembershipsForAppInstanceUser :: Text -> ListChannelMembershipsForAppInstanceUser
- data ListChannelMembershipsForAppInstanceUserResponse = ListChannelMembershipsForAppInstanceUserResponse' (Maybe [ChannelMembershipForAppInstanceUserSummary]) (Maybe (Sensitive Text)) Int
- newListChannelMembershipsForAppInstanceUserResponse :: Int -> ListChannelMembershipsForAppInstanceUserResponse
- data ListChannelMessages = ListChannelMessages' (Maybe Natural) (Maybe (Sensitive Text)) (Maybe POSIX) (Maybe POSIX) (Maybe SortOrder) (Maybe Text) Text Text
- newListChannelMessages :: Text -> Text -> ListChannelMessages
- data ListChannelMessagesResponse = ListChannelMessagesResponse' (Maybe Text) (Maybe [ChannelMessageSummary]) (Maybe (Sensitive Text)) (Maybe Text) Int
- newListChannelMessagesResponse :: Int -> ListChannelMessagesResponse
- data ListChannelModerators = ListChannelModerators' (Maybe Natural) (Maybe (Sensitive Text)) Text Text
- newListChannelModerators :: Text -> Text -> ListChannelModerators
- data ListChannelModeratorsResponse = ListChannelModeratorsResponse' (Maybe Text) (Maybe [ChannelModeratorSummary]) (Maybe (Sensitive Text)) Int
- newListChannelModeratorsResponse :: Int -> ListChannelModeratorsResponse
- data ListChannels = ListChannels' (Maybe Natural) (Maybe (Sensitive Text)) (Maybe ChannelPrivacy) Text Text
- newListChannels :: Text -> Text -> ListChannels
- data ListChannelsResponse = ListChannelsResponse' (Maybe [ChannelSummary]) (Maybe (Sensitive Text)) Int
- newListChannelsResponse :: Int -> ListChannelsResponse
- data ListChannelsAssociatedWithChannelFlow = ListChannelsAssociatedWithChannelFlow' (Maybe Natural) (Maybe (Sensitive Text)) Text
- newListChannelsAssociatedWithChannelFlow :: Text -> ListChannelsAssociatedWithChannelFlow
- data ListChannelsAssociatedWithChannelFlowResponse = ListChannelsAssociatedWithChannelFlowResponse' (Maybe [ChannelAssociatedWithFlowSummary]) (Maybe (Sensitive Text)) Int
- newListChannelsAssociatedWithChannelFlowResponse :: Int -> ListChannelsAssociatedWithChannelFlowResponse
- data ListChannelsModeratedByAppInstanceUser = ListChannelsModeratedByAppInstanceUser' (Maybe Text) (Maybe Natural) (Maybe (Sensitive Text)) Text
- newListChannelsModeratedByAppInstanceUser :: Text -> ListChannelsModeratedByAppInstanceUser
- data ListChannelsModeratedByAppInstanceUserResponse = ListChannelsModeratedByAppInstanceUserResponse' (Maybe [ChannelModeratedByAppInstanceUserSummary]) (Maybe (Sensitive Text)) Int
- newListChannelsModeratedByAppInstanceUserResponse :: Int -> ListChannelsModeratedByAppInstanceUserResponse
- data ListSubChannels = ListSubChannels' (Maybe Natural) (Maybe (Sensitive Text)) Text Text
- newListSubChannels :: Text -> Text -> ListSubChannels
- data ListSubChannelsResponse = ListSubChannelsResponse' (Maybe Text) (Maybe (Sensitive Text)) (Maybe [SubChannelSummary]) Int
- newListSubChannelsResponse :: Int -> ListSubChannelsResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe (NonEmpty Tag)) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data PutChannelMembershipPreferences = PutChannelMembershipPreferences' Text Text Text ChannelMembershipPreferences
- newPutChannelMembershipPreferences :: Text -> Text -> Text -> ChannelMembershipPreferences -> PutChannelMembershipPreferences
- data PutChannelMembershipPreferencesResponse = PutChannelMembershipPreferencesResponse' (Maybe Text) (Maybe Identity) (Maybe ChannelMembershipPreferences) Int
- newPutChannelMembershipPreferencesResponse :: Int -> PutChannelMembershipPreferencesResponse
- data RedactChannelMessage = RedactChannelMessage' (Maybe Text) Text Text Text
- newRedactChannelMessage :: Text -> Text -> Text -> RedactChannelMessage
- data RedactChannelMessageResponse = RedactChannelMessageResponse' (Maybe Text) (Maybe Text) (Maybe Text) Int
- newRedactChannelMessageResponse :: Int -> RedactChannelMessageResponse
- data SearchChannels = SearchChannels' (Maybe Text) (Maybe Natural) (Maybe (Sensitive Text)) (NonEmpty SearchField)
- newSearchChannels :: NonEmpty SearchField -> SearchChannels
- data SearchChannelsResponse = SearchChannelsResponse' (Maybe [ChannelSummary]) (Maybe (Sensitive Text)) Int
- newSearchChannelsResponse :: Int -> SearchChannelsResponse
- data SendChannelMessage = SendChannelMessage' (Maybe (HashMap Text MessageAttributeValue)) (Maybe (Sensitive Text)) (Maybe PushNotificationConfiguration) (Maybe Text) Text (Sensitive Text) ChannelMessageType ChannelMessagePersistenceType (Sensitive Text) Text
- newSendChannelMessage :: Text -> Text -> ChannelMessageType -> ChannelMessagePersistenceType -> Text -> Text -> SendChannelMessage
- data SendChannelMessageResponse = SendChannelMessageResponse' (Maybe Text) (Maybe Text) (Maybe ChannelMessageStatusStructure) (Maybe Text) Int
- newSendChannelMessageResponse :: Int -> SendChannelMessageResponse
- data TagResource = TagResource' Text (NonEmpty Tag)
- newTagResource :: Text -> NonEmpty Tag -> TagResource
- data TagResourceResponse = TagResourceResponse' {
- newTagResourceResponse :: TagResourceResponse
- data UntagResource = UntagResource' Text (NonEmpty (Sensitive Text))
- newUntagResource :: Text -> NonEmpty Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' {
- newUntagResourceResponse :: UntagResourceResponse
- data UpdateChannel = UpdateChannel' (Maybe (Sensitive Text)) (Maybe ChannelMode) (Maybe (Sensitive Text)) Text Text
- newUpdateChannel :: Text -> Text -> UpdateChannel
- data UpdateChannelResponse = UpdateChannelResponse' (Maybe Text) Int
- newUpdateChannelResponse :: Int -> UpdateChannelResponse
- data UpdateChannelFlow = UpdateChannelFlow' Text (NonEmpty Processor) (Sensitive Text)
- newUpdateChannelFlow :: Text -> NonEmpty Processor -> Text -> UpdateChannelFlow
- data UpdateChannelFlowResponse = UpdateChannelFlowResponse' (Maybe Text) Int
- newUpdateChannelFlowResponse :: Int -> UpdateChannelFlowResponse
- data UpdateChannelMessage = UpdateChannelMessage' (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe Text) Text Text Text
- newUpdateChannelMessage :: Text -> Text -> Text -> UpdateChannelMessage
- data UpdateChannelMessageResponse = UpdateChannelMessageResponse' (Maybe Text) (Maybe Text) (Maybe ChannelMessageStatusStructure) (Maybe Text) Int
- newUpdateChannelMessageResponse :: Int -> UpdateChannelMessageResponse
- data UpdateChannelReadMarker = UpdateChannelReadMarker' (Maybe Text) Text Text
- newUpdateChannelReadMarker :: Text -> Text -> UpdateChannelReadMarker
- data UpdateChannelReadMarkerResponse = UpdateChannelReadMarkerResponse' (Maybe Text) (Maybe Text) Int
- newUpdateChannelReadMarkerResponse :: Int -> UpdateChannelReadMarkerResponse
- newtype AllowNotifications where
- AllowNotifications' { }
- pattern AllowNotifications_ALL :: AllowNotifications
- pattern AllowNotifications_FILTERED :: AllowNotifications
- pattern AllowNotifications_NONE :: AllowNotifications
- newtype ChannelMembershipType where
- newtype ChannelMessagePersistenceType where
- newtype ChannelMessageStatus where
- newtype ChannelMessageType where
- newtype ChannelMode where
- ChannelMode' { }
- pattern ChannelMode_RESTRICTED :: ChannelMode
- pattern ChannelMode_UNRESTRICTED :: ChannelMode
- newtype ChannelPrivacy where
- ChannelPrivacy' { }
- pattern ChannelPrivacy_PRIVATE :: ChannelPrivacy
- pattern ChannelPrivacy_PUBLIC :: ChannelPrivacy
- newtype ErrorCode where
- ErrorCode' { }
- pattern ErrorCode_AccessDenied :: ErrorCode
- pattern ErrorCode_BadRequest :: ErrorCode
- pattern ErrorCode_Conflict :: ErrorCode
- pattern ErrorCode_Forbidden :: ErrorCode
- pattern ErrorCode_NotFound :: ErrorCode
- pattern ErrorCode_PhoneNumberAssociationsExist :: ErrorCode
- pattern ErrorCode_PreconditionFailed :: ErrorCode
- pattern ErrorCode_ResourceLimitExceeded :: ErrorCode
- pattern ErrorCode_ServiceFailure :: ErrorCode
- pattern ErrorCode_ServiceUnavailable :: ErrorCode
- pattern ErrorCode_Throttled :: ErrorCode
- pattern ErrorCode_Throttling :: ErrorCode
- pattern ErrorCode_Unauthorized :: ErrorCode
- pattern ErrorCode_Unprocessable :: ErrorCode
- pattern ErrorCode_VoiceConnectorGroupAssociationsExist :: ErrorCode
- newtype FallbackAction where
- FallbackAction' { }
- pattern FallbackAction_ABORT :: FallbackAction
- pattern FallbackAction_CONTINUE :: FallbackAction
- newtype InvocationType where
- InvocationType' { }
- pattern InvocationType_ASYNC :: InvocationType
- newtype PushNotificationType where
- newtype SearchFieldKey where
- SearchFieldKey' { }
- pattern SearchFieldKey_MEMBERS :: SearchFieldKey
- newtype SearchFieldOperator where
- newtype SortOrder where
- SortOrder' { }
- pattern SortOrder_ASCENDING :: SortOrder
- pattern SortOrder_DESCENDING :: SortOrder
- data AppInstanceUserMembershipSummary = AppInstanceUserMembershipSummary' (Maybe POSIX) (Maybe Text) (Maybe ChannelMembershipType)
- newAppInstanceUserMembershipSummary :: AppInstanceUserMembershipSummary
- data BatchChannelMemberships = BatchChannelMemberships' (Maybe Text) (Maybe Identity) (Maybe [Identity]) (Maybe Text) (Maybe ChannelMembershipType)
- newBatchChannelMemberships :: BatchChannelMemberships
- data BatchCreateChannelMembershipError = BatchCreateChannelMembershipError' (Maybe ErrorCode) (Maybe Text) (Maybe Text)
- newBatchCreateChannelMembershipError :: BatchCreateChannelMembershipError
- data Channel = Channel' (Maybe Text) (Maybe Text) (Maybe Identity) (Maybe POSIX) (Maybe ElasticChannelConfiguration) (Maybe POSIX) (Maybe POSIX) (Maybe (Sensitive Text)) (Maybe ChannelMode) (Maybe (Sensitive Text)) (Maybe ChannelPrivacy)
- newChannel :: Channel
- data ChannelAssociatedWithFlowSummary = ChannelAssociatedWithFlowSummary' (Maybe Text) (Maybe (Sensitive Text)) (Maybe ChannelMode) (Maybe (Sensitive Text)) (Maybe ChannelPrivacy)
- newChannelAssociatedWithFlowSummary :: ChannelAssociatedWithFlowSummary
- data ChannelBan = ChannelBan' (Maybe Text) (Maybe Identity) (Maybe POSIX) (Maybe Identity)
- newChannelBan :: ChannelBan
- data ChannelBanSummary = ChannelBanSummary' (Maybe Identity)
- newChannelBanSummary :: ChannelBanSummary
- data ChannelFlow = ChannelFlow' (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe (Sensitive Text)) (Maybe (NonEmpty Processor))
- newChannelFlow :: ChannelFlow
- data ChannelFlowSummary = ChannelFlowSummary' (Maybe Text) (Maybe (Sensitive Text)) (Maybe (NonEmpty Processor))
- newChannelFlowSummary :: ChannelFlowSummary
- data ChannelMembership = ChannelMembership' (Maybe Text) (Maybe POSIX) (Maybe Identity) (Maybe POSIX) (Maybe Identity) (Maybe Text) (Maybe ChannelMembershipType)
- newChannelMembership :: ChannelMembership
- data ChannelMembershipForAppInstanceUserSummary = ChannelMembershipForAppInstanceUserSummary' (Maybe AppInstanceUserMembershipSummary) (Maybe ChannelSummary)
- newChannelMembershipForAppInstanceUserSummary :: ChannelMembershipForAppInstanceUserSummary
- data ChannelMembershipPreferences = ChannelMembershipPreferences' (Maybe PushNotificationPreferences)
- newChannelMembershipPreferences :: ChannelMembershipPreferences
- data ChannelMembershipSummary = ChannelMembershipSummary' (Maybe Identity)
- newChannelMembershipSummary :: ChannelMembershipSummary
- data ChannelMessage = ChannelMessage' (Maybe Text) (Maybe (Sensitive Text)) (Maybe POSIX) (Maybe POSIX) (Maybe POSIX) (Maybe (HashMap Text MessageAttributeValue)) (Maybe Text) (Maybe (Sensitive Text)) (Maybe ChannelMessagePersistenceType) (Maybe Bool) (Maybe Identity) (Maybe ChannelMessageStatusStructure) (Maybe Text) (Maybe ChannelMessageType)
- newChannelMessage :: ChannelMessage
- data ChannelMessageCallback = ChannelMessageCallback' (Maybe (Sensitive Text)) (Maybe (HashMap Text MessageAttributeValue)) (Maybe (Sensitive Text)) (Maybe PushNotificationConfiguration) (Maybe Text) Text
- newChannelMessageCallback :: Text -> ChannelMessageCallback
- data ChannelMessageStatusStructure = ChannelMessageStatusStructure' (Maybe Text) (Maybe ChannelMessageStatus)
- newChannelMessageStatusStructure :: ChannelMessageStatusStructure
- data ChannelMessageSummary = ChannelMessageSummary' (Maybe (Sensitive Text)) (Maybe POSIX) (Maybe POSIX) (Maybe POSIX) (Maybe (HashMap Text MessageAttributeValue)) (Maybe Text) (Maybe (Sensitive Text)) (Maybe Bool) (Maybe Identity) (Maybe ChannelMessageStatusStructure) (Maybe ChannelMessageType)
- newChannelMessageSummary :: ChannelMessageSummary
- data ChannelModeratedByAppInstanceUserSummary = ChannelModeratedByAppInstanceUserSummary' (Maybe ChannelSummary)
- newChannelModeratedByAppInstanceUserSummary :: ChannelModeratedByAppInstanceUserSummary
- data ChannelModerator = ChannelModerator' (Maybe Text) (Maybe Identity) (Maybe POSIX) (Maybe Identity)
- newChannelModerator :: ChannelModerator
- data ChannelModeratorSummary = ChannelModeratorSummary' (Maybe Identity)
- newChannelModeratorSummary :: ChannelModeratorSummary
- data ChannelSummary = ChannelSummary' (Maybe Text) (Maybe POSIX) (Maybe (Sensitive Text)) (Maybe ChannelMode) (Maybe (Sensitive Text)) (Maybe ChannelPrivacy)
- newChannelSummary :: ChannelSummary
- data ElasticChannelConfiguration = ElasticChannelConfiguration' Natural Natural Natural
- newElasticChannelConfiguration :: Natural -> Natural -> Natural -> ElasticChannelConfiguration
- data Identity = Identity' (Maybe Text) (Maybe (Sensitive Text))
- newIdentity :: Identity
- data LambdaConfiguration = LambdaConfiguration' Text InvocationType
- newLambdaConfiguration :: Text -> InvocationType -> LambdaConfiguration
- data MessageAttributeValue = MessageAttributeValue' (Maybe [Sensitive Text])
- newMessageAttributeValue :: MessageAttributeValue
- data MessagingSessionEndpoint = MessagingSessionEndpoint' (Maybe Text)
- newMessagingSessionEndpoint :: MessagingSessionEndpoint
- data Processor = Processor' (Sensitive Text) ProcessorConfiguration Natural FallbackAction
- newProcessor :: Text -> ProcessorConfiguration -> Natural -> FallbackAction -> Processor
- data ProcessorConfiguration = ProcessorConfiguration' LambdaConfiguration
- newProcessorConfiguration :: LambdaConfiguration -> ProcessorConfiguration
- data PushNotificationConfiguration = PushNotificationConfiguration' (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe PushNotificationType)
- newPushNotificationConfiguration :: PushNotificationConfiguration
- data PushNotificationPreferences = PushNotificationPreferences' (Maybe (Sensitive Text)) AllowNotifications
- newPushNotificationPreferences :: AllowNotifications -> PushNotificationPreferences
- data SearchField = SearchField' SearchFieldKey (NonEmpty Text) SearchFieldOperator
- newSearchField :: SearchFieldKey -> NonEmpty Text -> SearchFieldOperator -> SearchField
- data SubChannelSummary = SubChannelSummary' (Maybe Int) (Maybe Text)
- newSubChannelSummary :: SubChannelSummary
- data Tag = Tag' (Sensitive Text) (Sensitive Text)
- newTag :: Text -> Text -> Tag
Service Configuration
defaultService :: Service Source #
API version 2021-05-15
of the Amazon Chime SDK Messaging SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by ChimeSDKMessaging
.
BadRequestException
_BadRequestException :: AsError a => Fold a ServiceError Source #
The input parameters don't match the service's restrictions.
ConflictException
_ConflictException :: AsError a => Fold a ServiceError Source #
The request could not be processed because of conflict in the current state of the resource.
ForbiddenException
_ForbiddenException :: AsError a => Fold a ServiceError Source #
The client is permanently forbidden from making the request.
NotFoundException
_NotFoundException :: AsError a => Fold a ServiceError Source #
One or more of the resources in the request does not exist in the system.
ResourceLimitExceededException
_ResourceLimitExceededException :: AsError a => Fold a ServiceError Source #
The request exceeds the resource limit.
ServiceFailureException
_ServiceFailureException :: AsError a => Fold a ServiceError Source #
The service encountered an unexpected error.
ServiceUnavailableException
_ServiceUnavailableException :: AsError a => Fold a ServiceError Source #
The service is currently unavailable.
ThrottledClientException
_ThrottledClientException :: AsError a => Fold a ServiceError Source #
The client exceeded its request rate limit.
UnauthorizedClientException
_UnauthorizedClientException :: AsError a => Fold a ServiceError Source #
The client is not currently authorized to make the request.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
AssociateChannelFlow
data AssociateChannelFlow Source #
See: newAssociateChannelFlow
smart constructor.
Instances
newAssociateChannelFlow Source #
:: Text | |
-> Text | |
-> Text | |
-> AssociateChannelFlow |
Create a value of AssociateChannelFlow
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
AssociateChannelFlow
, associateChannelFlow_channelArn
- The ARN of the channel.
AssociateChannelFlow
, associateChannelFlow_channelFlowArn
- The ARN of the channel flow.
$sel:chimeBearer:AssociateChannelFlow'
, associateChannelFlow_chimeBearer
- The AppInstanceUserArn
of the user making the API call.
data AssociateChannelFlowResponse Source #
See: newAssociateChannelFlowResponse
smart constructor.
Instances
newAssociateChannelFlowResponse :: AssociateChannelFlowResponse Source #
Create a value of AssociateChannelFlowResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
BatchCreateChannelMembership
data BatchCreateChannelMembership Source #
See: newBatchCreateChannelMembership
smart constructor.
Instances
newBatchCreateChannelMembership Source #
:: Text | |
-> NonEmpty Text | |
-> Text | |
-> BatchCreateChannelMembership |
Create a value of BatchCreateChannelMembership
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
BatchCreateChannelMembership
, batchCreateChannelMembership_subChannelId
- The ID of the SubChannel in the request.
Only required when creating membership in a SubChannel for a moderator in an elastic channel.
BatchCreateChannelMembership
, batchCreateChannelMembership_type
- The membership type of a user, DEFAULT
or HIDDEN
. Default members
are always returned as part of ListChannelMemberships
. Hidden members
are only returned if the type filter in ListChannelMemberships
equals
HIDDEN
. Otherwise hidden members are not returned. This is only
supported by moderators.
BatchCreateChannelMembership
, batchCreateChannelMembership_channelArn
- The ARN of the channel to which you're adding users.
$sel:memberArns:BatchCreateChannelMembership'
, batchCreateChannelMembership_memberArns
- The AppInstanceUserArn
s of the members you want to add to the channel.
$sel:chimeBearer:BatchCreateChannelMembership'
, batchCreateChannelMembership_chimeBearer
- The AppInstanceUserArn
of the user that makes the API call.
data BatchCreateChannelMembershipResponse Source #
See: newBatchCreateChannelMembershipResponse
smart constructor.
BatchCreateChannelMembershipResponse' (Maybe BatchChannelMemberships) (Maybe [BatchCreateChannelMembershipError]) Int |
Instances
newBatchCreateChannelMembershipResponse Source #
Create a value of BatchCreateChannelMembershipResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:batchChannelMemberships:BatchCreateChannelMembershipResponse'
, batchCreateChannelMembershipResponse_batchChannelMemberships
- The list of channel memberships in the response.
$sel:errors:BatchCreateChannelMembershipResponse'
, batchCreateChannelMembershipResponse_errors
- If the action fails for one or more of the memberships in the request, a
list of the memberships is returned, along with error codes and error
messages.
$sel:httpStatus:BatchCreateChannelMembershipResponse'
, batchCreateChannelMembershipResponse_httpStatus
- The response's http status code.
ChannelFlowCallback
data ChannelFlowCallback Source #
See: newChannelFlowCallback
smart constructor.
Instances
newChannelFlowCallback Source #
Create a value of ChannelFlowCallback
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deleteResource:ChannelFlowCallback'
, channelFlowCallback_deleteResource
- When a processor determines that a message needs to be DENIED
, pass
this parameter with a value of true.
ChannelFlowCallback
, channelFlowCallback_callbackId
- The identifier passed to the processor by the service when invoked. Use
the identifier to call back the service.
ChannelFlowCallback
, channelFlowCallback_channelArn
- The ARN of the channel.
$sel:channelMessage:ChannelFlowCallback'
, channelFlowCallback_channelMessage
- Stores information about the processed message.
data ChannelFlowCallbackResponse Source #
See: newChannelFlowCallbackResponse
smart constructor.
Instances
newChannelFlowCallbackResponse Source #
Create a value of ChannelFlowCallbackResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ChannelFlowCallback
, channelFlowCallbackResponse_callbackId
- The call back ID passed in the request.
ChannelFlowCallback
, channelFlowCallbackResponse_channelArn
- The ARN of the channel.
$sel:httpStatus:ChannelFlowCallbackResponse'
, channelFlowCallbackResponse_httpStatus
- The response's http status code.
CreateChannel
data CreateChannel Source #
See: newCreateChannel
smart constructor.
CreateChannel' (Maybe (Sensitive Text)) (Maybe ElasticChannelConfiguration) (Maybe (NonEmpty Text)) (Maybe (Sensitive Text)) (Maybe ChannelMode) (Maybe (NonEmpty Text)) (Maybe ChannelPrivacy) (Maybe (NonEmpty Tag)) Text (Sensitive Text) (Sensitive Text) Text |
Instances
:: Text | |
-> Text | |
-> Text | |
-> Text | |
-> CreateChannel |
Create a value of CreateChannel
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:channelId:CreateChannel'
, createChannel_channelId
- The ID of the channel in the request.
CreateChannel
, createChannel_elasticChannelConfiguration
- The attributes required to configure and create an elastic channel. An
elastic channel can support a maximum of 1-million users, excluding
moderators.
$sel:memberArns:CreateChannel'
, createChannel_memberArns
- The ARNs of the channel members in the request.
CreateChannel
, createChannel_metadata
- The metadata of the creation request. Limited to 1KB and UTF-8.
CreateChannel
, createChannel_mode
- 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.
$sel:moderatorArns:CreateChannel'
, createChannel_moderatorArns
- The ARNs of the channel moderators in the request.
CreateChannel
, createChannel_privacy
- 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
.
$sel:tags:CreateChannel'
, createChannel_tags
- The tags for the creation request.
$sel:appInstanceArn:CreateChannel'
, createChannel_appInstanceArn
- The ARN of the channel request.
CreateChannel
, createChannel_name
- The name of the channel.
$sel:clientRequestToken:CreateChannel'
, createChannel_clientRequestToken
- The client token for the request. An Idempotency
token.
$sel:chimeBearer:CreateChannel'
, createChannel_chimeBearer
- The AppInstanceUserArn
of the user that makes the API call.
data CreateChannelResponse Source #
See: newCreateChannelResponse
smart constructor.
Instances
newCreateChannelResponse Source #
Create a value of CreateChannelResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateChannelResponse
, createChannelResponse_channelArn
- The ARN of the channel.
$sel:httpStatus:CreateChannelResponse'
, createChannelResponse_httpStatus
- The response's http status code.
CreateChannelBan
data CreateChannelBan Source #
See: newCreateChannelBan
smart constructor.
Instances
:: Text | |
-> Text | |
-> Text | |
-> CreateChannelBan |
Create a value of CreateChannelBan
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateChannelBan
, createChannelBan_channelArn
- The ARN of the ban request.
CreateChannelBan
, createChannelBan_memberArn
- The AppInstanceUserArn
of the member being banned.
$sel:chimeBearer:CreateChannelBan'
, createChannelBan_chimeBearer
- The AppInstanceUserArn
of the user that makes the API call.
data CreateChannelBanResponse Source #
See: newCreateChannelBanResponse
smart constructor.
Instances
newCreateChannelBanResponse Source #
Create a value of CreateChannelBanResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateChannelBan
, createChannelBanResponse_channelArn
- The ARN of the response to the ban request.
CreateChannelBanResponse
, createChannelBanResponse_member
- The ChannelArn
and BannedIdentity
of the member in the ban response.
$sel:httpStatus:CreateChannelBanResponse'
, createChannelBanResponse_httpStatus
- The response's http status code.
CreateChannelFlow
data CreateChannelFlow Source #
See: newCreateChannelFlow
smart constructor.
CreateChannelFlow' (Maybe (NonEmpty Tag)) Text (NonEmpty Processor) (Sensitive Text) (Sensitive Text) |
Instances
Create a value of CreateChannelFlow
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:CreateChannelFlow'
, createChannelFlow_tags
- The tags for the creation request.
$sel:appInstanceArn:CreateChannelFlow'
, createChannelFlow_appInstanceArn
- The ARN of the channel flow request.
CreateChannelFlow
, createChannelFlow_processors
- Information about the processor Lambda functions.
CreateChannelFlow
, createChannelFlow_name
- The name of the channel flow.
$sel:clientRequestToken:CreateChannelFlow'
, createChannelFlow_clientRequestToken
- The client token for the request. An Idempotency token.
data CreateChannelFlowResponse Source #
See: newCreateChannelFlowResponse
smart constructor.
Instances
newCreateChannelFlowResponse Source #
Create a value of CreateChannelFlowResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateChannelFlowResponse
, createChannelFlowResponse_channelFlowArn
- The ARN of the channel flow.
$sel:httpStatus:CreateChannelFlowResponse'
, createChannelFlowResponse_httpStatus
- The response's http status code.
CreateChannelMembership
data CreateChannelMembership Source #
See: newCreateChannelMembership
smart constructor.
Instances
newCreateChannelMembership Source #
:: Text | |
-> Text | |
-> ChannelMembershipType | |
-> Text | |
-> CreateChannelMembership |
Create a value of CreateChannelMembership
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateChannelMembership
, createChannelMembership_subChannelId
- The ID of the SubChannel in the request.
Only required when creating membership in a SubChannel for a moderator in an elastic channel.
CreateChannelMembership
, createChannelMembership_channelArn
- The ARN of the channel to which you're adding users.
CreateChannelMembership
, createChannelMembership_memberArn
- The AppInstanceUserArn
of the member you want to add to the channel.
CreateChannelMembership
, createChannelMembership_type
- The membership type of a user, DEFAULT
or HIDDEN
. Default members
are always returned as part of ListChannelMemberships
. Hidden members
are only returned if the type filter in ListChannelMemberships
equals
HIDDEN
. Otherwise hidden members are not returned. This is only
supported by moderators.
$sel:chimeBearer:CreateChannelMembership'
, createChannelMembership_chimeBearer
- The AppInstanceUserArn
of the user that makes the API call.
data CreateChannelMembershipResponse Source #
See: newCreateChannelMembershipResponse
smart constructor.
Instances
newCreateChannelMembershipResponse Source #
Create a value of CreateChannelMembershipResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateChannelMembership
, createChannelMembershipResponse_channelArn
- The ARN of the channel.
CreateChannelMembershipResponse
, createChannelMembershipResponse_member
- The ARN and metadata of the member being added.
CreateChannelMembership
, createChannelMembershipResponse_subChannelId
- The ID of the SubChannel in the response.
$sel:httpStatus:CreateChannelMembershipResponse'
, createChannelMembershipResponse_httpStatus
- The response's http status code.
CreateChannelModerator
data CreateChannelModerator Source #
See: newCreateChannelModerator
smart constructor.
Instances
newCreateChannelModerator Source #
:: Text | |
-> Text | |
-> Text | |
-> CreateChannelModerator |
Create a value of CreateChannelModerator
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateChannelModerator
, createChannelModerator_channelArn
- The ARN of the channel.
$sel:channelModeratorArn:CreateChannelModerator'
, createChannelModerator_channelModeratorArn
- The AppInstanceUserArn
of the moderator.
$sel:chimeBearer:CreateChannelModerator'
, createChannelModerator_chimeBearer
- The AppInstanceUserArn
of the user that makes the API call.
data CreateChannelModeratorResponse Source #
See: newCreateChannelModeratorResponse
smart constructor.
Instances
newCreateChannelModeratorResponse Source #
Create a value of CreateChannelModeratorResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateChannelModerator
, createChannelModeratorResponse_channelArn
- The ARN of the channel.
$sel:channelModerator:CreateChannelModeratorResponse'
, createChannelModeratorResponse_channelModerator
- The ARNs of the channel and the moderator.
$sel:httpStatus:CreateChannelModeratorResponse'
, createChannelModeratorResponse_httpStatus
- The response's http status code.
DeleteChannel
data DeleteChannel Source #
See: newDeleteChannel
smart constructor.
Instances
Create a value of DeleteChannel
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteChannel
, deleteChannel_subChannelId
- The ID of the SubChannel in the request.
DeleteChannel
, deleteChannel_channelArn
- The ARN of the channel being deleted.
$sel:chimeBearer:DeleteChannel'
, deleteChannel_chimeBearer
- The AppInstanceUserArn
of the user that makes the API call.
data DeleteChannelResponse Source #
See: newDeleteChannelResponse
smart constructor.
Instances
Generic DeleteChannelResponse Source # | |
Defined in Amazonka.ChimeSDKMessaging.DeleteChannel type Rep DeleteChannelResponse :: Type -> Type # | |
Read DeleteChannelResponse Source # | |
Show DeleteChannelResponse Source # | |
Defined in Amazonka.ChimeSDKMessaging.DeleteChannel showsPrec :: Int -> DeleteChannelResponse -> ShowS # show :: DeleteChannelResponse -> String # showList :: [DeleteChannelResponse] -> ShowS # | |
NFData DeleteChannelResponse Source # | |
Defined in Amazonka.ChimeSDKMessaging.DeleteChannel rnf :: DeleteChannelResponse -> () # | |
Eq DeleteChannelResponse Source # | |
Defined in Amazonka.ChimeSDKMessaging.DeleteChannel (==) :: DeleteChannelResponse -> DeleteChannelResponse -> Bool # (/=) :: DeleteChannelResponse -> DeleteChannelResponse -> Bool # | |
type Rep DeleteChannelResponse Source # | |
Defined in Amazonka.ChimeSDKMessaging.DeleteChannel |
newDeleteChannelResponse :: DeleteChannelResponse Source #
Create a value of DeleteChannelResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteChannelBan
data DeleteChannelBan Source #
See: newDeleteChannelBan
smart constructor.
Instances
:: Text | |
-> Text | |
-> Text | |
-> DeleteChannelBan |
Create a value of DeleteChannelBan
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteChannelBan
, deleteChannelBan_channelArn
- The ARN of the channel from which the AppInstanceUser
was banned.
DeleteChannelBan
, deleteChannelBan_memberArn
- The ARN of the AppInstanceUser
that you want to reinstate.
$sel:chimeBearer:DeleteChannelBan'
, deleteChannelBan_chimeBearer
- The AppInstanceUserArn
of the user that makes the API call.
data DeleteChannelBanResponse Source #
See: newDeleteChannelBanResponse
smart constructor.
Instances
newDeleteChannelBanResponse :: DeleteChannelBanResponse Source #
Create a value of DeleteChannelBanResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteChannelFlow
data DeleteChannelFlow Source #
See: newDeleteChannelFlow
smart constructor.
Instances
Create a value of DeleteChannelFlow
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteChannelFlow
, deleteChannelFlow_channelFlowArn
- The ARN of the channel flow.
data DeleteChannelFlowResponse Source #
See: newDeleteChannelFlowResponse
smart constructor.
Instances
newDeleteChannelFlowResponse :: DeleteChannelFlowResponse Source #
Create a value of DeleteChannelFlowResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteChannelMembership
data DeleteChannelMembership Source #
See: newDeleteChannelMembership
smart constructor.
Instances
newDeleteChannelMembership Source #
:: Text | |
-> Text | |
-> Text | |
-> DeleteChannelMembership |
Create a value of DeleteChannelMembership
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteChannelMembership
, deleteChannelMembership_subChannelId
- The ID of the SubChannel in the request.
Only for use by moderators.
DeleteChannelMembership
, deleteChannelMembership_channelArn
- The ARN of the channel from which you want to remove the user.
DeleteChannelMembership
, deleteChannelMembership_memberArn
- The AppInstanceUserArn
of the member that you're removing from the
channel.
$sel:chimeBearer:DeleteChannelMembership'
, deleteChannelMembership_chimeBearer
- The AppInstanceUserArn
of the user that makes the API call.
data DeleteChannelMembershipResponse Source #
See: newDeleteChannelMembershipResponse
smart constructor.
Instances
newDeleteChannelMembershipResponse :: DeleteChannelMembershipResponse Source #
Create a value of DeleteChannelMembershipResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteChannelMessage
data DeleteChannelMessage Source #
See: newDeleteChannelMessage
smart constructor.
Instances
newDeleteChannelMessage Source #
:: Text | |
-> Text | |
-> Text | |
-> DeleteChannelMessage |
Create a value of DeleteChannelMessage
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteChannelMessage
, deleteChannelMessage_subChannelId
- The ID of the SubChannel in the request.
Only required when deleting messages in a SubChannel that the user belongs to.
DeleteChannelMessage
, deleteChannelMessage_channelArn
- The ARN of the channel.
DeleteChannelMessage
, deleteChannelMessage_messageId
- The ID of the message being deleted.
$sel:chimeBearer:DeleteChannelMessage'
, deleteChannelMessage_chimeBearer
- The AppInstanceUserArn
of the user that makes the API call.
data DeleteChannelMessageResponse Source #
See: newDeleteChannelMessageResponse
smart constructor.
Instances
newDeleteChannelMessageResponse :: DeleteChannelMessageResponse Source #
Create a value of DeleteChannelMessageResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteChannelModerator
data DeleteChannelModerator Source #
See: newDeleteChannelModerator
smart constructor.
Instances
newDeleteChannelModerator Source #
:: Text | |
-> Text | |
-> Text | |
-> DeleteChannelModerator |
Create a value of DeleteChannelModerator
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteChannelModerator
, deleteChannelModerator_channelArn
- The ARN of the channel.
$sel:channelModeratorArn:DeleteChannelModerator'
, deleteChannelModerator_channelModeratorArn
- The AppInstanceUserArn
of the moderator being deleted.
$sel:chimeBearer:DeleteChannelModerator'
, deleteChannelModerator_chimeBearer
- The AppInstanceUserArn
of the user that makes the API call.
data DeleteChannelModeratorResponse Source #
See: newDeleteChannelModeratorResponse
smart constructor.
Instances
newDeleteChannelModeratorResponse :: DeleteChannelModeratorResponse Source #
Create a value of DeleteChannelModeratorResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DescribeChannel
data DescribeChannel Source #
See: newDescribeChannel
smart constructor.
Instances
Create a value of DescribeChannel
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeChannel
, describeChannel_channelArn
- The ARN of the channel.
$sel:chimeBearer:DescribeChannel'
, describeChannel_chimeBearer
- The AppInstanceUserArn
of the user that makes the API call.
data DescribeChannelResponse Source #
See: newDescribeChannelResponse
smart constructor.
Instances
newDescribeChannelResponse Source #
Create a value of DescribeChannelResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:channel:DescribeChannelResponse'
, describeChannelResponse_channel
- The channel details.
$sel:httpStatus:DescribeChannelResponse'
, describeChannelResponse_httpStatus
- The response's http status code.
DescribeChannelBan
data DescribeChannelBan Source #
See: newDescribeChannelBan
smart constructor.
Instances
newDescribeChannelBan Source #
:: Text | |
-> Text | |
-> Text | |
-> DescribeChannelBan |
Create a value of DescribeChannelBan
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeChannelBan
, describeChannelBan_channelArn
- The ARN of the channel from which the user is banned.
DescribeChannelBan
, describeChannelBan_memberArn
- The AppInstanceUserArn
of the member being banned.
$sel:chimeBearer:DescribeChannelBan'
, describeChannelBan_chimeBearer
- The AppInstanceUserArn
of the user that makes the API call.
data DescribeChannelBanResponse Source #
See: newDescribeChannelBanResponse
smart constructor.
Instances
newDescribeChannelBanResponse Source #
Create a value of DescribeChannelBanResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:channelBan:DescribeChannelBanResponse'
, describeChannelBanResponse_channelBan
- The details of the ban.
$sel:httpStatus:DescribeChannelBanResponse'
, describeChannelBanResponse_httpStatus
- The response's http status code.
DescribeChannelFlow
data DescribeChannelFlow Source #
See: newDescribeChannelFlow
smart constructor.
Instances
newDescribeChannelFlow Source #
Create a value of DescribeChannelFlow
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeChannelFlow
, describeChannelFlow_channelFlowArn
- The ARN of the channel flow.
data DescribeChannelFlowResponse Source #
See: newDescribeChannelFlowResponse
smart constructor.
Instances
newDescribeChannelFlowResponse Source #
Create a value of DescribeChannelFlowResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:channelFlow:DescribeChannelFlowResponse'
, describeChannelFlowResponse_channelFlow
- The channel flow details.
$sel:httpStatus:DescribeChannelFlowResponse'
, describeChannelFlowResponse_httpStatus
- The response's http status code.
DescribeChannelMembership
data DescribeChannelMembership Source #
See: newDescribeChannelMembership
smart constructor.
Instances
newDescribeChannelMembership Source #
:: Text | |
-> Text | |
-> Text | |
-> DescribeChannelMembership |
Create a value of DescribeChannelMembership
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeChannelMembership
, describeChannelMembership_subChannelId
- The ID of the SubChannel in the request. The response contains an
ElasticChannelConfiguration
object.
Only required to get a user’s SubChannel membership details.
DescribeChannelMembership
, describeChannelMembership_channelArn
- The ARN of the channel.
DescribeChannelMembership
, describeChannelMembership_memberArn
- The AppInstanceUserArn
of the member.
$sel:chimeBearer:DescribeChannelMembership'
, describeChannelMembership_chimeBearer
- The AppInstanceUserArn
of the user that makes the API call.
data DescribeChannelMembershipResponse Source #
See: newDescribeChannelMembershipResponse
smart constructor.
Instances
Generic DescribeChannelMembershipResponse Source # | |
Show DescribeChannelMembershipResponse Source # | |
NFData DescribeChannelMembershipResponse Source # | |
Defined in Amazonka.ChimeSDKMessaging.DescribeChannelMembership rnf :: DescribeChannelMembershipResponse -> () # | |
Eq DescribeChannelMembershipResponse Source # | |
type Rep DescribeChannelMembershipResponse Source # | |
Defined in Amazonka.ChimeSDKMessaging.DescribeChannelMembership type Rep DescribeChannelMembershipResponse = D1 ('MetaData "DescribeChannelMembershipResponse" "Amazonka.ChimeSDKMessaging.DescribeChannelMembership" "amazonka-chime-sdk-messaging-2.0-BxY1AbjLoDB4AQUv82PCQZ" 'False) (C1 ('MetaCons "DescribeChannelMembershipResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "channelMembership") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChannelMembership)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newDescribeChannelMembershipResponse Source #
Create a value of DescribeChannelMembershipResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:channelMembership:DescribeChannelMembershipResponse'
, describeChannelMembershipResponse_channelMembership
- The details of the membership.
$sel:httpStatus:DescribeChannelMembershipResponse'
, describeChannelMembershipResponse_httpStatus
- The response's http status code.
DescribeChannelMembershipForAppInstanceUser
data DescribeChannelMembershipForAppInstanceUser Source #
See: newDescribeChannelMembershipForAppInstanceUser
smart constructor.
Instances
newDescribeChannelMembershipForAppInstanceUser Source #
:: Text | |
-> Text |
|
-> Text |
|
-> DescribeChannelMembershipForAppInstanceUser |
Create a value of DescribeChannelMembershipForAppInstanceUser
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeChannelMembershipForAppInstanceUser
, describeChannelMembershipForAppInstanceUser_channelArn
- The ARN of the channel to which the user belongs.
$sel:appInstanceUserArn:DescribeChannelMembershipForAppInstanceUser'
, describeChannelMembershipForAppInstanceUser_appInstanceUserArn
- The ARN of the user in a channel.
$sel:chimeBearer:DescribeChannelMembershipForAppInstanceUser'
, describeChannelMembershipForAppInstanceUser_chimeBearer
- The AppInstanceUserArn
of the user that makes the API call.
data DescribeChannelMembershipForAppInstanceUserResponse Source #
See: newDescribeChannelMembershipForAppInstanceUserResponse
smart constructor.
DescribeChannelMembershipForAppInstanceUserResponse' (Maybe ChannelMembershipForAppInstanceUserSummary) Int |
Instances
newDescribeChannelMembershipForAppInstanceUserResponse Source #
:: Int |
|
-> DescribeChannelMembershipForAppInstanceUserResponse |
Create a value of DescribeChannelMembershipForAppInstanceUserResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:channelMembership:DescribeChannelMembershipForAppInstanceUserResponse'
, describeChannelMembershipForAppInstanceUserResponse_channelMembership
- The channel to which a user belongs.
$sel:httpStatus:DescribeChannelMembershipForAppInstanceUserResponse'
, describeChannelMembershipForAppInstanceUserResponse_httpStatus
- The response's http status code.
DescribeChannelModeratedByAppInstanceUser
data DescribeChannelModeratedByAppInstanceUser Source #
See: newDescribeChannelModeratedByAppInstanceUser
smart constructor.
Instances
newDescribeChannelModeratedByAppInstanceUser Source #
:: Text | |
-> Text |
|
-> Text | |
-> DescribeChannelModeratedByAppInstanceUser |
Create a value of DescribeChannelModeratedByAppInstanceUser
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeChannelModeratedByAppInstanceUser
, describeChannelModeratedByAppInstanceUser_channelArn
- The ARN of the moderated channel.
$sel:appInstanceUserArn:DescribeChannelModeratedByAppInstanceUser'
, describeChannelModeratedByAppInstanceUser_appInstanceUserArn
- The ARN of the AppInstanceUser
in the moderated channel.
$sel:chimeBearer:DescribeChannelModeratedByAppInstanceUser'
, describeChannelModeratedByAppInstanceUser_chimeBearer
- The AppInstanceUserArn
of the user that makes the API call.
data DescribeChannelModeratedByAppInstanceUserResponse Source #
See: newDescribeChannelModeratedByAppInstanceUserResponse
smart constructor.
DescribeChannelModeratedByAppInstanceUserResponse' (Maybe ChannelModeratedByAppInstanceUserSummary) Int |
Instances
newDescribeChannelModeratedByAppInstanceUserResponse Source #
:: Int |
|
-> DescribeChannelModeratedByAppInstanceUserResponse |
Create a value of DescribeChannelModeratedByAppInstanceUserResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:channel:DescribeChannelModeratedByAppInstanceUserResponse'
, describeChannelModeratedByAppInstanceUserResponse_channel
- The moderated channel.
$sel:httpStatus:DescribeChannelModeratedByAppInstanceUserResponse'
, describeChannelModeratedByAppInstanceUserResponse_httpStatus
- The response's http status code.
DescribeChannelModerator
data DescribeChannelModerator Source #
See: newDescribeChannelModerator
smart constructor.
Instances
newDescribeChannelModerator Source #
:: Text | |
-> Text | |
-> Text | |
-> DescribeChannelModerator |
Create a value of DescribeChannelModerator
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeChannelModerator
, describeChannelModerator_channelArn
- The ARN of the channel.
$sel:channelModeratorArn:DescribeChannelModerator'
, describeChannelModerator_channelModeratorArn
- The AppInstanceUserArn
of the channel moderator.
$sel:chimeBearer:DescribeChannelModerator'
, describeChannelModerator_chimeBearer
- The AppInstanceUserArn
of the user that makes the API call.
data DescribeChannelModeratorResponse Source #
See: newDescribeChannelModeratorResponse
smart constructor.
Instances
Generic DescribeChannelModeratorResponse Source # | |
Show DescribeChannelModeratorResponse Source # | |
NFData DescribeChannelModeratorResponse Source # | |
Defined in Amazonka.ChimeSDKMessaging.DescribeChannelModerator rnf :: DescribeChannelModeratorResponse -> () # | |
Eq DescribeChannelModeratorResponse Source # | |
type Rep DescribeChannelModeratorResponse Source # | |
Defined in Amazonka.ChimeSDKMessaging.DescribeChannelModerator type Rep DescribeChannelModeratorResponse = D1 ('MetaData "DescribeChannelModeratorResponse" "Amazonka.ChimeSDKMessaging.DescribeChannelModerator" "amazonka-chime-sdk-messaging-2.0-BxY1AbjLoDB4AQUv82PCQZ" 'False) (C1 ('MetaCons "DescribeChannelModeratorResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "channelModerator") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChannelModerator)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newDescribeChannelModeratorResponse Source #
Create a value of DescribeChannelModeratorResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:channelModerator:DescribeChannelModeratorResponse'
, describeChannelModeratorResponse_channelModerator
- The details of the channel moderator.
$sel:httpStatus:DescribeChannelModeratorResponse'
, describeChannelModeratorResponse_httpStatus
- The response's http status code.
DisassociateChannelFlow
data DisassociateChannelFlow Source #
See: newDisassociateChannelFlow
smart constructor.
Instances
newDisassociateChannelFlow Source #
:: Text | |
-> Text | |
-> Text | |
-> DisassociateChannelFlow |
Create a value of DisassociateChannelFlow
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DisassociateChannelFlow
, disassociateChannelFlow_channelArn
- The ARN of the channel.
DisassociateChannelFlow
, disassociateChannelFlow_channelFlowArn
- The ARN of the channel flow.
$sel:chimeBearer:DisassociateChannelFlow'
, disassociateChannelFlow_chimeBearer
- The AppInstanceUserArn
of the user making the API call.
data DisassociateChannelFlowResponse Source #
See: newDisassociateChannelFlowResponse
smart constructor.
Instances
newDisassociateChannelFlowResponse :: DisassociateChannelFlowResponse Source #
Create a value of DisassociateChannelFlowResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
GetChannelMembershipPreferences
data GetChannelMembershipPreferences Source #
See: newGetChannelMembershipPreferences
smart constructor.
Instances
newGetChannelMembershipPreferences Source #
:: Text | |
-> Text | |
-> Text | |
-> GetChannelMembershipPreferences |
Create a value of GetChannelMembershipPreferences
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetChannelMembershipPreferences
, getChannelMembershipPreferences_channelArn
- The ARN of the channel.
GetChannelMembershipPreferences
, getChannelMembershipPreferences_memberArn
- The AppInstanceUserArn
of the member retrieving the preferences.
$sel:chimeBearer:GetChannelMembershipPreferences'
, getChannelMembershipPreferences_chimeBearer
- The AppInstanceUserARN
of the user making the API call.
data GetChannelMembershipPreferencesResponse Source #
See: newGetChannelMembershipPreferencesResponse
smart constructor.
GetChannelMembershipPreferencesResponse' (Maybe Text) (Maybe Identity) (Maybe ChannelMembershipPreferences) Int |
Instances
newGetChannelMembershipPreferencesResponse Source #
Create a value of GetChannelMembershipPreferencesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetChannelMembershipPreferences
, getChannelMembershipPreferencesResponse_channelArn
- The ARN of the channel.
GetChannelMembershipPreferencesResponse
, getChannelMembershipPreferencesResponse_member
- The details of a user.
$sel:preferences:GetChannelMembershipPreferencesResponse'
, getChannelMembershipPreferencesResponse_preferences
- The channel membership preferences for an AppInstanceUser
.
$sel:httpStatus:GetChannelMembershipPreferencesResponse'
, getChannelMembershipPreferencesResponse_httpStatus
- The response's http status code.
GetChannelMessage
data GetChannelMessage Source #
See: newGetChannelMessage
smart constructor.
Instances
:: Text | |
-> Text | |
-> Text | |
-> GetChannelMessage |
Create a value of GetChannelMessage
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetChannelMessage
, getChannelMessage_subChannelId
- The ID of the SubChannel in the request.
Only required when getting messages in a SubChannel that the user belongs to.
GetChannelMessage
, getChannelMessage_channelArn
- The ARN of the channel.
GetChannelMessage
, getChannelMessage_messageId
- The ID of the message.
$sel:chimeBearer:GetChannelMessage'
, getChannelMessage_chimeBearer
- The AppInstanceUserArn
of the user that makes the API call.
data GetChannelMessageResponse Source #
See: newGetChannelMessageResponse
smart constructor.
Instances
newGetChannelMessageResponse Source #
Create a value of GetChannelMessageResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:channelMessage:GetChannelMessageResponse'
, getChannelMessageResponse_channelMessage
- The details of and content in the message.
$sel:httpStatus:GetChannelMessageResponse'
, getChannelMessageResponse_httpStatus
- The response's http status code.
GetChannelMessageStatus
data GetChannelMessageStatus Source #
See: newGetChannelMessageStatus
smart constructor.
Instances
newGetChannelMessageStatus Source #
:: Text | |
-> Text | |
-> Text | |
-> GetChannelMessageStatus |
Create a value of GetChannelMessageStatus
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetChannelMessageStatus
, getChannelMessageStatus_subChannelId
- The ID of the SubChannel in the request.
Only required when getting message status in a SubChannel that the user belongs to.
GetChannelMessageStatus
, getChannelMessageStatus_channelArn
- The ARN of the channel
GetChannelMessageStatus
, getChannelMessageStatus_messageId
- The ID of the message.
$sel:chimeBearer:GetChannelMessageStatus'
, getChannelMessageStatus_chimeBearer
- The AppInstanceUserArn
of the user making the API call.
data GetChannelMessageStatusResponse Source #
See: newGetChannelMessageStatusResponse
smart constructor.
Instances
Generic GetChannelMessageStatusResponse Source # | |
Read GetChannelMessageStatusResponse Source # | |
Show GetChannelMessageStatusResponse Source # | |
NFData GetChannelMessageStatusResponse Source # | |
Defined in Amazonka.ChimeSDKMessaging.GetChannelMessageStatus rnf :: GetChannelMessageStatusResponse -> () # | |
Eq GetChannelMessageStatusResponse Source # | |
type Rep GetChannelMessageStatusResponse Source # | |
Defined in Amazonka.ChimeSDKMessaging.GetChannelMessageStatus type Rep GetChannelMessageStatusResponse = D1 ('MetaData "GetChannelMessageStatusResponse" "Amazonka.ChimeSDKMessaging.GetChannelMessageStatus" "amazonka-chime-sdk-messaging-2.0-BxY1AbjLoDB4AQUv82PCQZ" 'False) (C1 ('MetaCons "GetChannelMessageStatusResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChannelMessageStatusStructure)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newGetChannelMessageStatusResponse Source #
Create a value of GetChannelMessageStatusResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetChannelMessageStatusResponse
, getChannelMessageStatusResponse_status
- The message status and details.
$sel:httpStatus:GetChannelMessageStatusResponse'
, getChannelMessageStatusResponse_httpStatus
- The response's http status code.
GetMessagingSessionEndpoint
data GetMessagingSessionEndpoint Source #
See: newGetMessagingSessionEndpoint
smart constructor.
Instances
newGetMessagingSessionEndpoint :: GetMessagingSessionEndpoint Source #
Create a value of GetMessagingSessionEndpoint
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data GetMessagingSessionEndpointResponse Source #
See: newGetMessagingSessionEndpointResponse
smart constructor.
Instances
newGetMessagingSessionEndpointResponse Source #
Create a value of GetMessagingSessionEndpointResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:endpoint:GetMessagingSessionEndpointResponse'
, getMessagingSessionEndpointResponse_endpoint
- The endpoint returned in the response.
$sel:httpStatus:GetMessagingSessionEndpointResponse'
, getMessagingSessionEndpointResponse_httpStatus
- The response's http status code.
ListChannelBans
data ListChannelBans Source #
See: newListChannelBans
smart constructor.
Instances
Create a value of ListChannelBans
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListChannelBans'
, listChannelBans_maxResults
- The maximum number of bans that you want returned.
ListChannelBans
, listChannelBans_nextToken
- The token passed by previous API calls until all requested bans are
returned.
ListChannelBans
, listChannelBans_channelArn
- The ARN of the channel.
$sel:chimeBearer:ListChannelBans'
, listChannelBans_chimeBearer
- The AppInstanceUserArn
of the user that makes the API call.
data ListChannelBansResponse Source #
See: newListChannelBansResponse
smart constructor.
Instances
newListChannelBansResponse Source #
Create a value of ListChannelBansResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListChannelBans
, listChannelBansResponse_channelArn
- The ARN of the channel.
$sel:channelBans:ListChannelBansResponse'
, listChannelBansResponse_channelBans
- The information for each requested ban.
ListChannelBans
, listChannelBansResponse_nextToken
- The token passed by previous API calls until all requested bans are
returned.
$sel:httpStatus:ListChannelBansResponse'
, listChannelBansResponse_httpStatus
- The response's http status code.
ListChannelFlows
data ListChannelFlows Source #
See: newListChannelFlows
smart constructor.
Instances
Create a value of ListChannelFlows
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListChannelFlows'
, listChannelFlows_maxResults
- The maximum number of channel flows that you want to return.
ListChannelFlows
, listChannelFlows_nextToken
- The token passed by previous API calls until all requested channel flows
are returned.
$sel:appInstanceArn:ListChannelFlows'
, listChannelFlows_appInstanceArn
- The ARN of the app instance.
data ListChannelFlowsResponse Source #
See: newListChannelFlowsResponse
smart constructor.
Instances
newListChannelFlowsResponse Source #
Create a value of ListChannelFlowsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:channelFlows:ListChannelFlowsResponse'
, listChannelFlowsResponse_channelFlows
- The information about each channel flow.
ListChannelFlows
, listChannelFlowsResponse_nextToken
- The token passed by previous API calls until all requested channels are
returned.
$sel:httpStatus:ListChannelFlowsResponse'
, listChannelFlowsResponse_httpStatus
- The response's http status code.
ListChannelMemberships
data ListChannelMemberships Source #
See: newListChannelMemberships
smart constructor.
ListChannelMemberships' (Maybe Natural) (Maybe (Sensitive Text)) (Maybe Text) (Maybe ChannelMembershipType) Text Text |
Instances
newListChannelMemberships Source #
:: Text | |
-> Text | |
-> ListChannelMemberships |
Create a value of ListChannelMemberships
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListChannelMemberships'
, listChannelMemberships_maxResults
- The maximum number of channel memberships that you want returned.
ListChannelMemberships
, listChannelMemberships_nextToken
- The token passed by previous API calls until all requested channel
memberships are returned.
ListChannelMemberships
, listChannelMemberships_subChannelId
- 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
, listChannelMemberships_type
- 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
, listChannelMemberships_channelArn
- The maximum number of channel memberships that you want returned.
$sel:chimeBearer:ListChannelMemberships'
, listChannelMemberships_chimeBearer
- The AppInstanceUserArn
of the user that makes the API call.
data ListChannelMembershipsResponse Source #
See: newListChannelMembershipsResponse
smart constructor.
ListChannelMembershipsResponse' (Maybe Text) (Maybe [ChannelMembershipSummary]) (Maybe (Sensitive Text)) Int |
Instances
newListChannelMembershipsResponse Source #
Create a value of ListChannelMembershipsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListChannelMemberships
, listChannelMembershipsResponse_channelArn
- The ARN of the channel.
$sel:channelMemberships:ListChannelMembershipsResponse'
, listChannelMembershipsResponse_channelMemberships
- The information for the requested channel memberships.
ListChannelMemberships
, listChannelMembershipsResponse_nextToken
- The token passed by previous API calls until all requested channel
memberships are returned.
$sel:httpStatus:ListChannelMembershipsResponse'
, listChannelMembershipsResponse_httpStatus
- The response's http status code.
ListChannelMembershipsForAppInstanceUser
data ListChannelMembershipsForAppInstanceUser Source #
See: newListChannelMembershipsForAppInstanceUser
smart constructor.
ListChannelMembershipsForAppInstanceUser' (Maybe Text) (Maybe Natural) (Maybe (Sensitive Text)) Text |
Instances
newListChannelMembershipsForAppInstanceUser Source #
Create a value of ListChannelMembershipsForAppInstanceUser
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:appInstanceUserArn:ListChannelMembershipsForAppInstanceUser'
, listChannelMembershipsForAppInstanceUser_appInstanceUserArn
- The ARN of the AppInstanceUser
s
$sel:maxResults:ListChannelMembershipsForAppInstanceUser'
, listChannelMembershipsForAppInstanceUser_maxResults
- The maximum number of users that you want returned.
ListChannelMembershipsForAppInstanceUser
, listChannelMembershipsForAppInstanceUser_nextToken
- The token returned from previous API requests until the number of
channel memberships is reached.
$sel:chimeBearer:ListChannelMembershipsForAppInstanceUser'
, listChannelMembershipsForAppInstanceUser_chimeBearer
- The AppInstanceUserArn
of the user that makes the API call.
data ListChannelMembershipsForAppInstanceUserResponse Source #
See: newListChannelMembershipsForAppInstanceUserResponse
smart constructor.
ListChannelMembershipsForAppInstanceUserResponse' (Maybe [ChannelMembershipForAppInstanceUserSummary]) (Maybe (Sensitive Text)) Int |
Instances
newListChannelMembershipsForAppInstanceUserResponse Source #
:: Int |
|
-> ListChannelMembershipsForAppInstanceUserResponse |
Create a value of ListChannelMembershipsForAppInstanceUserResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:channelMemberships:ListChannelMembershipsForAppInstanceUserResponse'
, listChannelMembershipsForAppInstanceUserResponse_channelMemberships
- The information for the requested channel memberships.
ListChannelMembershipsForAppInstanceUser
, listChannelMembershipsForAppInstanceUserResponse_nextToken
- The token passed by previous API calls until all requested users are
returned.
$sel:httpStatus:ListChannelMembershipsForAppInstanceUserResponse'
, listChannelMembershipsForAppInstanceUserResponse_httpStatus
- The response's http status code.
ListChannelMessages
data ListChannelMessages Source #
See: newListChannelMessages
smart constructor.
ListChannelMessages' (Maybe Natural) (Maybe (Sensitive Text)) (Maybe POSIX) (Maybe POSIX) (Maybe SortOrder) (Maybe Text) Text Text |
Instances
newListChannelMessages Source #
Create a value of ListChannelMessages
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListChannelMessages'
, listChannelMessages_maxResults
- The maximum number of messages that you want returned.
ListChannelMessages
, listChannelMessages_nextToken
- The token passed by previous API calls until all requested messages are
returned.
$sel:notAfter:ListChannelMessages'
, listChannelMessages_notAfter
- The final or ending time stamp for your requested messages.
$sel:notBefore:ListChannelMessages'
, listChannelMessages_notBefore
- The initial or starting time stamp for your requested messages.
$sel:sortOrder:ListChannelMessages'
, listChannelMessages_sortOrder
- The order in which you want messages sorted. Default is Descending,
based on time created.
ListChannelMessages
, listChannelMessages_subChannelId
- The ID of the SubChannel in the request.
Only required when listing the messages in a SubChannel that the user belongs to.
ListChannelMessages
, listChannelMessages_channelArn
- The ARN of the channel.
$sel:chimeBearer:ListChannelMessages'
, listChannelMessages_chimeBearer
- The AppInstanceUserArn
of the user that makes the API call.
data ListChannelMessagesResponse Source #
See: newListChannelMessagesResponse
smart constructor.
ListChannelMessagesResponse' (Maybe Text) (Maybe [ChannelMessageSummary]) (Maybe (Sensitive Text)) (Maybe Text) Int |
Instances
newListChannelMessagesResponse Source #
Create a value of ListChannelMessagesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListChannelMessages
, listChannelMessagesResponse_channelArn
- The ARN of the channel containing the requested messages.
$sel:channelMessages:ListChannelMessagesResponse'
, listChannelMessagesResponse_channelMessages
- The information about, and content of, each requested message.
ListChannelMessages
, listChannelMessagesResponse_nextToken
- The token passed by previous API calls until all requested messages are
returned.
ListChannelMessages
, listChannelMessagesResponse_subChannelId
- The ID of the SubChannel in the response.
$sel:httpStatus:ListChannelMessagesResponse'
, listChannelMessagesResponse_httpStatus
- The response's http status code.
ListChannelModerators
data ListChannelModerators Source #
See: newListChannelModerators
smart constructor.
Instances
newListChannelModerators Source #
Create a value of ListChannelModerators
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListChannelModerators'
, listChannelModerators_maxResults
- The maximum number of moderators that you want returned.
ListChannelModerators
, listChannelModerators_nextToken
- The token passed by previous API calls until all requested moderators
are returned.
ListChannelModerators
, listChannelModerators_channelArn
- The ARN of the channel.
$sel:chimeBearer:ListChannelModerators'
, listChannelModerators_chimeBearer
- The AppInstanceUserArn
of the user that makes the API call.
data ListChannelModeratorsResponse Source #
See: newListChannelModeratorsResponse
smart constructor.
ListChannelModeratorsResponse' (Maybe Text) (Maybe [ChannelModeratorSummary]) (Maybe (Sensitive Text)) Int |
Instances
newListChannelModeratorsResponse Source #
Create a value of ListChannelModeratorsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListChannelModerators
, listChannelModeratorsResponse_channelArn
- The ARN of the channel.
$sel:channelModerators:ListChannelModeratorsResponse'
, listChannelModeratorsResponse_channelModerators
- The information about and names of each moderator.
ListChannelModerators
, listChannelModeratorsResponse_nextToken
- The token passed by previous API calls until all requested moderators
are returned.
$sel:httpStatus:ListChannelModeratorsResponse'
, listChannelModeratorsResponse_httpStatus
- The response's http status code.
ListChannels
data ListChannels Source #
See: newListChannels
smart constructor.
Instances
Create a value of ListChannels
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListChannels'
, listChannels_maxResults
- The maximum number of channels that you want to return.
ListChannels
, listChannels_nextToken
- The token passed by previous API calls until all requested channels are
returned.
ListChannels
, listChannels_privacy
- The privacy setting. PUBLIC
retrieves all the public channels.
PRIVATE
retrieves private channels. Only an AppInstanceAdmin
can
retrieve private channels.
$sel:appInstanceArn:ListChannels'
, listChannels_appInstanceArn
- The ARN of the AppInstance
.
$sel:chimeBearer:ListChannels'
, listChannels_chimeBearer
- The AppInstanceUserArn
of the user that makes the API call.
data ListChannelsResponse Source #
See: newListChannelsResponse
smart constructor.
Instances
newListChannelsResponse Source #
Create a value of ListChannelsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:channels:ListChannelsResponse'
, listChannelsResponse_channels
- The information about each channel.
ListChannels
, listChannelsResponse_nextToken
- The token returned from previous API requests until the number of
channels is reached.
$sel:httpStatus:ListChannelsResponse'
, listChannelsResponse_httpStatus
- The response's http status code.
ListChannelsAssociatedWithChannelFlow
data ListChannelsAssociatedWithChannelFlow Source #
See: newListChannelsAssociatedWithChannelFlow
smart constructor.
Instances
newListChannelsAssociatedWithChannelFlow Source #
Create a value of ListChannelsAssociatedWithChannelFlow
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListChannelsAssociatedWithChannelFlow'
, listChannelsAssociatedWithChannelFlow_maxResults
- The maximum number of channels that you want to return.
ListChannelsAssociatedWithChannelFlow
, listChannelsAssociatedWithChannelFlow_nextToken
- The token passed by previous API calls until all requested channels are
returned.
ListChannelsAssociatedWithChannelFlow
, listChannelsAssociatedWithChannelFlow_channelFlowArn
- The ARN of the channel flow.
data ListChannelsAssociatedWithChannelFlowResponse Source #
See: newListChannelsAssociatedWithChannelFlowResponse
smart constructor.
ListChannelsAssociatedWithChannelFlowResponse' (Maybe [ChannelAssociatedWithFlowSummary]) (Maybe (Sensitive Text)) Int |
Instances
newListChannelsAssociatedWithChannelFlowResponse Source #
:: Int |
|
-> ListChannelsAssociatedWithChannelFlowResponse |
Create a value of ListChannelsAssociatedWithChannelFlowResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:channels:ListChannelsAssociatedWithChannelFlowResponse'
, listChannelsAssociatedWithChannelFlowResponse_channels
- The information about each channel.
ListChannelsAssociatedWithChannelFlow
, listChannelsAssociatedWithChannelFlowResponse_nextToken
- The token passed by previous API calls until all requested channels are
returned.
$sel:httpStatus:ListChannelsAssociatedWithChannelFlowResponse'
, listChannelsAssociatedWithChannelFlowResponse_httpStatus
- The response's http status code.
ListChannelsModeratedByAppInstanceUser
data ListChannelsModeratedByAppInstanceUser Source #
See: newListChannelsModeratedByAppInstanceUser
smart constructor.
Instances
newListChannelsModeratedByAppInstanceUser Source #
Create a value of ListChannelsModeratedByAppInstanceUser
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:appInstanceUserArn:ListChannelsModeratedByAppInstanceUser'
, listChannelsModeratedByAppInstanceUser_appInstanceUserArn
- The ARN of the user in the moderated channel.
$sel:maxResults:ListChannelsModeratedByAppInstanceUser'
, listChannelsModeratedByAppInstanceUser_maxResults
- The maximum number of channels in the request.
ListChannelsModeratedByAppInstanceUser
, listChannelsModeratedByAppInstanceUser_nextToken
- The token returned from previous API requests until the number of
channels moderated by the user is reached.
$sel:chimeBearer:ListChannelsModeratedByAppInstanceUser'
, listChannelsModeratedByAppInstanceUser_chimeBearer
- The AppInstanceUserArn
of the user that makes the API call.
data ListChannelsModeratedByAppInstanceUserResponse Source #
See: newListChannelsModeratedByAppInstanceUserResponse
smart constructor.
ListChannelsModeratedByAppInstanceUserResponse' (Maybe [ChannelModeratedByAppInstanceUserSummary]) (Maybe (Sensitive Text)) Int |
Instances
newListChannelsModeratedByAppInstanceUserResponse Source #
:: Int |
|
-> ListChannelsModeratedByAppInstanceUserResponse |
Create a value of ListChannelsModeratedByAppInstanceUserResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:channels:ListChannelsModeratedByAppInstanceUserResponse'
, listChannelsModeratedByAppInstanceUserResponse_channels
- The moderated channels in the request.
ListChannelsModeratedByAppInstanceUser
, listChannelsModeratedByAppInstanceUserResponse_nextToken
- The token returned from previous API requests until the number of
channels moderated by the user is reached.
$sel:httpStatus:ListChannelsModeratedByAppInstanceUserResponse'
, listChannelsModeratedByAppInstanceUserResponse_httpStatus
- The response's http status code.
ListSubChannels
data ListSubChannels Source #
See: newListSubChannels
smart constructor.
Instances
Create a value of ListSubChannels
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListSubChannels'
, listSubChannels_maxResults
- The maximum number of sub-channels that you want to return.
ListSubChannels
, listSubChannels_nextToken
- The token passed by previous API calls until all requested sub-channels
are returned.
ListSubChannels
, listSubChannels_channelArn
- The ARN of elastic channel.
$sel:chimeBearer:ListSubChannels'
, listSubChannels_chimeBearer
- The AppInstanceUserArn
of the user making the API call.
data ListSubChannelsResponse Source #
See: newListSubChannelsResponse
smart constructor.
Instances
newListSubChannelsResponse Source #
Create a value of ListSubChannelsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListSubChannels
, listSubChannelsResponse_channelArn
- The ARN of elastic channel.
ListSubChannels
, listSubChannelsResponse_nextToken
- The token passed by previous API calls until all requested sub-channels
are returned.
$sel:subChannels:ListSubChannelsResponse'
, listSubChannelsResponse_subChannels
- The information about each sub-channel.
$sel:httpStatus:ListSubChannelsResponse'
, listSubChannelsResponse_httpStatus
- The response's http status code.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource
smart constructor.
Instances
newListTagsForResource Source #
Create a value of ListTagsForResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceARN:ListTagsForResource'
, listTagsForResource_resourceARN
- The ARN of the resource.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse
smart constructor.
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:ListTagsForResourceResponse'
, listTagsForResourceResponse_tags
- The tag key-value pairs.
$sel:httpStatus:ListTagsForResourceResponse'
, listTagsForResourceResponse_httpStatus
- The response's http status code.
PutChannelMembershipPreferences
data PutChannelMembershipPreferences Source #
See: newPutChannelMembershipPreferences
smart constructor.
Instances
newPutChannelMembershipPreferences Source #
Create a value of PutChannelMembershipPreferences
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
PutChannelMembershipPreferences
, putChannelMembershipPreferences_channelArn
- The ARN of the channel.
PutChannelMembershipPreferences
, putChannelMembershipPreferences_memberArn
- The AppInstanceUserArn
of the member setting the preferences.
$sel:chimeBearer:PutChannelMembershipPreferences'
, putChannelMembershipPreferences_chimeBearer
- The AppInstanceUserARN
of the user making the API call.
PutChannelMembershipPreferences
, putChannelMembershipPreferences_preferences
- The channel membership preferences of an AppInstanceUser
.
data PutChannelMembershipPreferencesResponse Source #
See: newPutChannelMembershipPreferencesResponse
smart constructor.
PutChannelMembershipPreferencesResponse' (Maybe Text) (Maybe Identity) (Maybe ChannelMembershipPreferences) Int |
Instances
newPutChannelMembershipPreferencesResponse Source #
Create a value of PutChannelMembershipPreferencesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
PutChannelMembershipPreferences
, putChannelMembershipPreferencesResponse_channelArn
- The ARN of the channel.
PutChannelMembershipPreferencesResponse
, putChannelMembershipPreferencesResponse_member
- The details of a user.
PutChannelMembershipPreferences
, putChannelMembershipPreferencesResponse_preferences
- The ARN and metadata of the member being added.
$sel:httpStatus:PutChannelMembershipPreferencesResponse'
, putChannelMembershipPreferencesResponse_httpStatus
- The response's http status code.
RedactChannelMessage
data RedactChannelMessage Source #
See: newRedactChannelMessage
smart constructor.
Instances
newRedactChannelMessage Source #
:: Text | |
-> Text | |
-> Text | |
-> RedactChannelMessage |
Create a value of RedactChannelMessage
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
RedactChannelMessage
, redactChannelMessage_subChannelId
- The ID of the SubChannel in the request.
RedactChannelMessage
, redactChannelMessage_channelArn
- The ARN of the channel containing the messages that you want to redact.
RedactChannelMessage
, redactChannelMessage_messageId
- The ID of the message being redacted.
$sel:chimeBearer:RedactChannelMessage'
, redactChannelMessage_chimeBearer
- The AppInstanceUserArn
of the user that makes the API call.
data RedactChannelMessageResponse Source #
See: newRedactChannelMessageResponse
smart constructor.
Instances
newRedactChannelMessageResponse Source #
Create a value of RedactChannelMessageResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
RedactChannelMessage
, redactChannelMessageResponse_channelArn
- The ARN of the channel containing the messages that you want to redact.
RedactChannelMessage
, redactChannelMessageResponse_messageId
- The ID of the message being redacted.
RedactChannelMessage
, redactChannelMessageResponse_subChannelId
- The ID of the SubChannel in the response.
Only required when redacting messages in a SubChannel that the user belongs to.
$sel:httpStatus:RedactChannelMessageResponse'
, redactChannelMessageResponse_httpStatus
- The response's http status code.
SearchChannels
data SearchChannels Source #
See: newSearchChannels
smart constructor.
SearchChannels' (Maybe Text) (Maybe Natural) (Maybe (Sensitive Text)) (NonEmpty SearchField) |
Instances
Create a value of SearchChannels
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:chimeBearer:SearchChannels'
, searchChannels_chimeBearer
- The AppInstanceUserArn
of the user making the API call.
$sel:maxResults:SearchChannels'
, searchChannels_maxResults
- The maximum number of channels that you want returned.
SearchChannels
, searchChannels_nextToken
- The token returned from previous API requests until the number of
channels is reached.
$sel:fields:SearchChannels'
, searchChannels_fields
- A list of the Field
objects in the channel being searched.
data SearchChannelsResponse Source #
See: newSearchChannelsResponse
smart constructor.
Instances
newSearchChannelsResponse Source #
Create a value of SearchChannelsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:channels:SearchChannelsResponse'
, searchChannelsResponse_channels
- A list of the channels in the request.
SearchChannels
, searchChannelsResponse_nextToken
- The token returned from previous API responses until the number of
channels is reached.
$sel:httpStatus:SearchChannelsResponse'
, searchChannelsResponse_httpStatus
- The response's http status code.
SendChannelMessage
data SendChannelMessage Source #
See: newSendChannelMessage
smart constructor.
Instances
newSendChannelMessage Source #
:: Text | |
-> Text | |
-> ChannelMessageType | |
-> ChannelMessagePersistenceType | |
-> Text | |
-> Text | |
-> SendChannelMessage |
Create a value of SendChannelMessage
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
SendChannelMessage
, sendChannelMessage_messageAttributes
- The attributes for the message, used for message filtering along with a
FilterRule
defined in the PushNotificationPreferences
.
SendChannelMessage
, sendChannelMessage_metadata
- The optional metadata for each message.
SendChannelMessage
, sendChannelMessage_pushNotification
- The push notification configuration of the message.
SendChannelMessage
, sendChannelMessage_subChannelId
- The ID of the SubChannel in the request.
SendChannelMessage
, sendChannelMessage_channelArn
- The ARN of the channel.
SendChannelMessage
, sendChannelMessage_content
- The content of the message.
SendChannelMessage
, sendChannelMessage_type
- The type of message, STANDARD
or CONTROL
.
SendChannelMessage
, sendChannelMessage_persistence
- Boolean that controls whether the message is persisted on the back end.
Required.
$sel:clientRequestToken:SendChannelMessage'
, sendChannelMessage_clientRequestToken
- The Idempotency
token for each client request.
$sel:chimeBearer:SendChannelMessage'
, sendChannelMessage_chimeBearer
- The AppInstanceUserArn
of the user that makes the API call.
data SendChannelMessageResponse Source #
See: newSendChannelMessageResponse
smart constructor.
SendChannelMessageResponse' (Maybe Text) (Maybe Text) (Maybe ChannelMessageStatusStructure) (Maybe Text) Int |
Instances
newSendChannelMessageResponse Source #
Create a value of SendChannelMessageResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
SendChannelMessage
, sendChannelMessageResponse_channelArn
- The ARN of the channel.
SendChannelMessageResponse
, sendChannelMessageResponse_messageId
- The ID string assigned to each message.
SendChannelMessageResponse
, sendChannelMessageResponse_status
- The status of the channel message.
SendChannelMessage
, sendChannelMessageResponse_subChannelId
- The ID of the SubChannel in the response.
$sel:httpStatus:SendChannelMessageResponse'
, sendChannelMessageResponse_httpStatus
- The response's http status code.
TagResource
data TagResource Source #
See: newTagResource
smart constructor.
Instances
Create a value of TagResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceARN:TagResource'
, tagResource_resourceARN
- The resource ARN.
$sel:tags:TagResource'
, tagResource_tags
- The tag key-value pairs.
data TagResourceResponse Source #
See: newTagResourceResponse
smart constructor.
Instances
Generic TagResourceResponse Source # | |
Defined in Amazonka.ChimeSDKMessaging.TagResource type Rep TagResourceResponse :: Type -> Type # from :: TagResourceResponse -> Rep TagResourceResponse x # to :: Rep TagResourceResponse x -> TagResourceResponse # | |
Read TagResourceResponse Source # | |
Show TagResourceResponse Source # | |
Defined in Amazonka.ChimeSDKMessaging.TagResource showsPrec :: Int -> TagResourceResponse -> ShowS # show :: TagResourceResponse -> String # showList :: [TagResourceResponse] -> ShowS # | |
NFData TagResourceResponse Source # | |
Defined in Amazonka.ChimeSDKMessaging.TagResource rnf :: TagResourceResponse -> () # | |
Eq TagResourceResponse Source # | |
Defined in Amazonka.ChimeSDKMessaging.TagResource (==) :: TagResourceResponse -> TagResourceResponse -> Bool # (/=) :: TagResourceResponse -> TagResourceResponse -> Bool # | |
type Rep TagResourceResponse Source # | |
Defined in Amazonka.ChimeSDKMessaging.TagResource |
newTagResourceResponse :: TagResourceResponse Source #
Create a value of TagResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
UntagResource
data UntagResource Source #
See: newUntagResource
smart constructor.
Instances
Create a value of UntagResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceARN:UntagResource'
, untagResource_resourceARN
- The resource ARN.
$sel:tagKeys:UntagResource'
, untagResource_tagKeys
- The tag keys.
data UntagResourceResponse Source #
See: newUntagResourceResponse
smart constructor.
Instances
Generic UntagResourceResponse Source # | |
Defined in Amazonka.ChimeSDKMessaging.UntagResource type Rep UntagResourceResponse :: Type -> Type # | |
Read UntagResourceResponse Source # | |
Show UntagResourceResponse Source # | |
Defined in Amazonka.ChimeSDKMessaging.UntagResource showsPrec :: Int -> UntagResourceResponse -> ShowS # show :: UntagResourceResponse -> String # showList :: [UntagResourceResponse] -> ShowS # | |
NFData UntagResourceResponse Source # | |
Defined in Amazonka.ChimeSDKMessaging.UntagResource rnf :: UntagResourceResponse -> () # | |
Eq UntagResourceResponse Source # | |
Defined in Amazonka.ChimeSDKMessaging.UntagResource (==) :: UntagResourceResponse -> UntagResourceResponse -> Bool # (/=) :: UntagResourceResponse -> UntagResourceResponse -> Bool # | |
type Rep UntagResourceResponse Source # | |
Defined in Amazonka.ChimeSDKMessaging.UntagResource |
newUntagResourceResponse :: UntagResourceResponse Source #
Create a value of UntagResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
UpdateChannel
data UpdateChannel Source #
See: newUpdateChannel
smart constructor.
Instances
Create a value of UpdateChannel
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateChannel
, updateChannel_metadata
- The metadata for the update request.
UpdateChannel
, updateChannel_mode
- The mode of the update request.
UpdateChannel
, updateChannel_name
- The name of the channel.
UpdateChannel
, updateChannel_channelArn
- The ARN of the channel.
$sel:chimeBearer:UpdateChannel'
, updateChannel_chimeBearer
- The AppInstanceUserArn
of the user that makes the API call.
data UpdateChannelResponse Source #
See: newUpdateChannelResponse
smart constructor.
Instances
newUpdateChannelResponse Source #
Create a value of UpdateChannelResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateChannel
, updateChannelResponse_channelArn
- The ARN of the channel.
$sel:httpStatus:UpdateChannelResponse'
, updateChannelResponse_httpStatus
- The response's http status code.
UpdateChannelFlow
data UpdateChannelFlow Source #
See: newUpdateChannelFlow
smart constructor.
Instances
:: Text | |
-> NonEmpty Processor | |
-> Text | |
-> UpdateChannelFlow |
Create a value of UpdateChannelFlow
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateChannelFlow
, updateChannelFlow_channelFlowArn
- The ARN of the channel flow.
UpdateChannelFlow
, updateChannelFlow_processors
- Information about the processor Lambda functions
UpdateChannelFlow
, updateChannelFlow_name
- The name of the channel flow.
data UpdateChannelFlowResponse Source #
See: newUpdateChannelFlowResponse
smart constructor.
Instances
newUpdateChannelFlowResponse Source #
Create a value of UpdateChannelFlowResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateChannelFlow
, updateChannelFlowResponse_channelFlowArn
- The ARN of the channel flow.
$sel:httpStatus:UpdateChannelFlowResponse'
, updateChannelFlowResponse_httpStatus
- The response's http status code.
UpdateChannelMessage
data UpdateChannelMessage Source #
See: newUpdateChannelMessage
smart constructor.
Instances
newUpdateChannelMessage Source #
:: Text | |
-> Text | |
-> Text | |
-> UpdateChannelMessage |
Create a value of UpdateChannelMessage
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateChannelMessage
, updateChannelMessage_content
- The content of the message being updated.
UpdateChannelMessage
, updateChannelMessage_metadata
- The metadata of the message being updated.
UpdateChannelMessage
, updateChannelMessage_subChannelId
- The ID of the SubChannel in the request.
Only required when updating messages in a SubChannel that the user belongs to.
UpdateChannelMessage
, updateChannelMessage_channelArn
- The ARN of the channel.
UpdateChannelMessage
, updateChannelMessage_messageId
- The ID string of the message being updated.
$sel:chimeBearer:UpdateChannelMessage'
, updateChannelMessage_chimeBearer
- The AppInstanceUserArn
of the user that makes the API call.
data UpdateChannelMessageResponse Source #
See: newUpdateChannelMessageResponse
smart constructor.
UpdateChannelMessageResponse' (Maybe Text) (Maybe Text) (Maybe ChannelMessageStatusStructure) (Maybe Text) Int |
Instances
newUpdateChannelMessageResponse Source #
Create a value of UpdateChannelMessageResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateChannelMessage
, updateChannelMessageResponse_channelArn
- The ARN of the channel.
UpdateChannelMessage
, updateChannelMessageResponse_messageId
- The ID string of the message being updated.
UpdateChannelMessageResponse
, updateChannelMessageResponse_status
- The status of the message update.
UpdateChannelMessage
, updateChannelMessageResponse_subChannelId
- The ID of the SubChannel in the response.
$sel:httpStatus:UpdateChannelMessageResponse'
, updateChannelMessageResponse_httpStatus
- The response's http status code.
UpdateChannelReadMarker
data UpdateChannelReadMarker Source #
See: newUpdateChannelReadMarker
smart constructor.
Instances
newUpdateChannelReadMarker Source #
:: Text | |
-> Text | |
-> UpdateChannelReadMarker |
Create a value of UpdateChannelReadMarker
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateChannelReadMarker
, updateChannelReadMarker_subChannelId
- The ID of the SubChannel in the request.
UpdateChannelReadMarker
, updateChannelReadMarker_channelArn
- The ARN of the channel.
$sel:chimeBearer:UpdateChannelReadMarker'
, updateChannelReadMarker_chimeBearer
- The AppInstanceUserArn
of the user that makes the API call.
data UpdateChannelReadMarkerResponse Source #
See: newUpdateChannelReadMarkerResponse
smart constructor.
Instances
newUpdateChannelReadMarkerResponse Source #
Create a value of UpdateChannelReadMarkerResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateChannelReadMarker
, updateChannelReadMarkerResponse_channelArn
- The ARN of the channel.
UpdateChannelReadMarker
, updateChannelReadMarkerResponse_subChannelId
- The ID of the SubChannel in the response.
$sel:httpStatus:UpdateChannelReadMarkerResponse'
, updateChannelReadMarkerResponse_httpStatus
- The response's http status code.
Types
AllowNotifications
newtype AllowNotifications Source #
pattern AllowNotifications_ALL :: AllowNotifications | |
pattern AllowNotifications_FILTERED :: AllowNotifications | |
pattern AllowNotifications_NONE :: AllowNotifications |
Instances
ChannelMembershipType
newtype ChannelMembershipType Source #
pattern ChannelMembershipType_DEFAULT :: ChannelMembershipType | |
pattern ChannelMembershipType_HIDDEN :: ChannelMembershipType |
Instances
ChannelMessagePersistenceType
newtype ChannelMessagePersistenceType Source #
pattern ChannelMessagePersistenceType_NON_PERSISTENT :: ChannelMessagePersistenceType | |
pattern ChannelMessagePersistenceType_PERSISTENT :: ChannelMessagePersistenceType |
Instances
ChannelMessageStatus
newtype ChannelMessageStatus Source #
pattern ChannelMessageStatus_DENIED :: ChannelMessageStatus | |
pattern ChannelMessageStatus_FAILED :: ChannelMessageStatus | |
pattern ChannelMessageStatus_PENDING :: ChannelMessageStatus | |
pattern ChannelMessageStatus_SENT :: ChannelMessageStatus |
Instances
ChannelMessageType
newtype ChannelMessageType Source #
pattern ChannelMessageType_CONTROL :: ChannelMessageType | |
pattern ChannelMessageType_STANDARD :: ChannelMessageType |
Instances
ChannelMode
newtype ChannelMode Source #
pattern ChannelMode_RESTRICTED :: ChannelMode | |
pattern ChannelMode_UNRESTRICTED :: ChannelMode |
Instances
ChannelPrivacy
newtype ChannelPrivacy Source #
pattern ChannelPrivacy_PRIVATE :: ChannelPrivacy | |
pattern ChannelPrivacy_PUBLIC :: ChannelPrivacy |
Instances
ErrorCode
pattern ErrorCode_AccessDenied :: ErrorCode | |
pattern ErrorCode_BadRequest :: ErrorCode | |
pattern ErrorCode_Conflict :: ErrorCode | |
pattern ErrorCode_Forbidden :: ErrorCode | |
pattern ErrorCode_NotFound :: ErrorCode | |
pattern ErrorCode_PhoneNumberAssociationsExist :: ErrorCode | |
pattern ErrorCode_PreconditionFailed :: ErrorCode | |
pattern ErrorCode_ResourceLimitExceeded :: ErrorCode | |
pattern ErrorCode_ServiceFailure :: ErrorCode | |
pattern ErrorCode_ServiceUnavailable :: ErrorCode | |
pattern ErrorCode_Throttled :: ErrorCode | |
pattern ErrorCode_Throttling :: ErrorCode | |
pattern ErrorCode_Unauthorized :: ErrorCode | |
pattern ErrorCode_Unprocessable :: ErrorCode | |
pattern ErrorCode_VoiceConnectorGroupAssociationsExist :: ErrorCode |
Instances
FallbackAction
newtype FallbackAction Source #
pattern FallbackAction_ABORT :: FallbackAction | |
pattern FallbackAction_CONTINUE :: FallbackAction |
Instances
InvocationType
newtype InvocationType Source #
pattern InvocationType_ASYNC :: InvocationType |
Instances
PushNotificationType
newtype PushNotificationType Source #
pattern PushNotificationType_DEFAULT :: PushNotificationType | |
pattern PushNotificationType_VOIP :: PushNotificationType |
Instances
SearchFieldKey
newtype SearchFieldKey Source #
pattern SearchFieldKey_MEMBERS :: SearchFieldKey |
Instances
SearchFieldOperator
newtype SearchFieldOperator Source #
pattern SearchFieldOperator_EQUALS :: SearchFieldOperator | |
pattern SearchFieldOperator_INCLUDES :: SearchFieldOperator |
Instances
SortOrder
pattern SortOrder_ASCENDING :: SortOrder | |
pattern SortOrder_DESCENDING :: SortOrder |
Instances
AppInstanceUserMembershipSummary
data AppInstanceUserMembershipSummary Source #
Summary of the membership details of an AppInstanceUser
.
See: newAppInstanceUserMembershipSummary
smart constructor.
Instances
newAppInstanceUserMembershipSummary :: AppInstanceUserMembershipSummary Source #
Create a value of AppInstanceUserMembershipSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:readMarkerTimestamp:AppInstanceUserMembershipSummary'
, appInstanceUserMembershipSummary_readMarkerTimestamp
- The time at which an AppInstanceUser
last marked a channel as read.
$sel:subChannelId:AppInstanceUserMembershipSummary'
, appInstanceUserMembershipSummary_subChannelId
- The ID of the SubChannel that the AppInstanceUser
is a member of.
$sel:type':AppInstanceUserMembershipSummary'
, appInstanceUserMembershipSummary_type
- The type of ChannelMembership
.
BatchChannelMemberships
data BatchChannelMemberships Source #
The membership information, including member ARNs, the channel ARN, and membership types.
See: newBatchChannelMemberships
smart constructor.
BatchChannelMemberships' (Maybe Text) (Maybe Identity) (Maybe [Identity]) (Maybe Text) (Maybe ChannelMembershipType) |
Instances
newBatchChannelMemberships :: BatchChannelMemberships Source #
Create a value of BatchChannelMemberships
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:channelArn:BatchChannelMemberships'
, batchChannelMemberships_channelArn
- The ARN of the channel to which you're adding users.
$sel:invitedBy:BatchChannelMemberships'
, batchChannelMemberships_invitedBy
- The identifier of the member who invited another member.
$sel:members:BatchChannelMemberships'
, batchChannelMemberships_members
- The users successfully added to the request.
$sel:subChannelId:BatchChannelMemberships'
, batchChannelMemberships_subChannelId
- The ID of the SubChannel.
$sel:type':BatchChannelMemberships'
, batchChannelMemberships_type
- The membership types set for the channel users.
BatchCreateChannelMembershipError
data BatchCreateChannelMembershipError Source #
A list of failed member ARNs, error codes, and error messages.
See: newBatchCreateChannelMembershipError
smart constructor.
Instances
newBatchCreateChannelMembershipError :: BatchCreateChannelMembershipError Source #
Create a value of BatchCreateChannelMembershipError
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:errorCode:BatchCreateChannelMembershipError'
, batchCreateChannelMembershipError_errorCode
- The error code.
$sel:errorMessage:BatchCreateChannelMembershipError'
, batchCreateChannelMembershipError_errorMessage
- The error message.
$sel:memberArn:BatchCreateChannelMembershipError'
, batchCreateChannelMembershipError_memberArn
- The AppInstanceUserArn
of the member that the service couldn't add.
Channel
The details of a channel.
See: newChannel
smart constructor.
Channel' (Maybe Text) (Maybe Text) (Maybe Identity) (Maybe POSIX) (Maybe ElasticChannelConfiguration) (Maybe POSIX) (Maybe POSIX) (Maybe (Sensitive Text)) (Maybe ChannelMode) (Maybe (Sensitive Text)) (Maybe ChannelPrivacy) |
Instances
newChannel :: Channel Source #
Create a value of Channel
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:channelArn:Channel'
, channel_channelArn
- The ARN of a channel.
$sel:channelFlowArn:Channel'
, channel_channelFlowArn
- The ARN of the channel flow.
$sel:createdBy:Channel'
, channel_createdBy
- The AppInstanceUser
who created the channel.
$sel:createdTimestamp:Channel'
, channel_createdTimestamp
- The time at which the AppInstanceUser
created the channel.
$sel:elasticChannelConfiguration:Channel'
, channel_elasticChannelConfiguration
- The attributes required to configure and create an elastic channel. An
elastic channel can support a maximum of 1-million members.
$sel:lastMessageTimestamp:Channel'
, channel_lastMessageTimestamp
- The time at which a member sent the last message in the channel.
$sel:lastUpdatedTimestamp:Channel'
, channel_lastUpdatedTimestamp
- The time at which a channel was last updated.
$sel:metadata:Channel'
, channel_metadata
- The channel's metadata.
$sel:mode:Channel'
, channel_mode
- The mode of the channel.
Channel
, channel_name
- The name of a channel.
$sel:privacy:Channel'
, channel_privacy
- The channel's privacy setting.
ChannelAssociatedWithFlowSummary
data ChannelAssociatedWithFlowSummary Source #
Summary of details of a channel associated with channel flow.
See: newChannelAssociatedWithFlowSummary
smart constructor.
ChannelAssociatedWithFlowSummary' (Maybe Text) (Maybe (Sensitive Text)) (Maybe ChannelMode) (Maybe (Sensitive Text)) (Maybe ChannelPrivacy) |
Instances
newChannelAssociatedWithFlowSummary :: ChannelAssociatedWithFlowSummary Source #
Create a value of ChannelAssociatedWithFlowSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:channelArn:ChannelAssociatedWithFlowSummary'
, channelAssociatedWithFlowSummary_channelArn
- The ARN of the channel.
$sel:metadata:ChannelAssociatedWithFlowSummary'
, channelAssociatedWithFlowSummary_metadata
- The channel's metadata.
$sel:mode:ChannelAssociatedWithFlowSummary'
, channelAssociatedWithFlowSummary_mode
- The mode of the channel.
$sel:name:ChannelAssociatedWithFlowSummary'
, channelAssociatedWithFlowSummary_name
- The name of the channel flow.
$sel:privacy:ChannelAssociatedWithFlowSummary'
, channelAssociatedWithFlowSummary_privacy
- The channel's privacy setting.
ChannelBan
data ChannelBan Source #
The details of a channel ban.
See: newChannelBan
smart constructor.
Instances
newChannelBan :: ChannelBan Source #
Create a value of ChannelBan
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:channelArn:ChannelBan'
, channelBan_channelArn
- The ARN of the channel from which a member is being banned.
$sel:createdBy:ChannelBan'
, channelBan_createdBy
- The AppInstanceUser
who created the ban.
$sel:createdTimestamp:ChannelBan'
, channelBan_createdTimestamp
- The time at which the ban was created.
$sel:member:ChannelBan'
, channelBan_member
- The member being banned from the channel.
ChannelBanSummary
data ChannelBanSummary Source #
Summary of the details of a ChannelBan
.
See: newChannelBanSummary
smart constructor.
Instances
newChannelBanSummary :: ChannelBanSummary Source #
Create a value of ChannelBanSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:member:ChannelBanSummary'
, channelBanSummary_member
- The member being banned from a channel.
ChannelFlow
data ChannelFlow Source #
The details of a channel flow.
See: newChannelFlow
smart constructor.
ChannelFlow' (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe (Sensitive Text)) (Maybe (NonEmpty Processor)) |
Instances
newChannelFlow :: ChannelFlow Source #
Create a value of ChannelFlow
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:channelFlowArn:ChannelFlow'
, channelFlow_channelFlowArn
- The ARN of the channel flow.
$sel:createdTimestamp:ChannelFlow'
, channelFlow_createdTimestamp
- The time at which the channel flow was created.
$sel:lastUpdatedTimestamp:ChannelFlow'
, channelFlow_lastUpdatedTimestamp
- The time at which a channel flow was updated.
ChannelFlow
, channelFlow_name
- The name of the channel flow.
$sel:processors:ChannelFlow'
, channelFlow_processors
- Information about the processor Lambda functions.
ChannelFlowSummary
data ChannelFlowSummary Source #
Summary of details of a channel flow.
See: newChannelFlowSummary
smart constructor.
Instances
newChannelFlowSummary :: ChannelFlowSummary Source #
Create a value of ChannelFlowSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:channelFlowArn:ChannelFlowSummary'
, channelFlowSummary_channelFlowArn
- The ARN of the channel flow.
ChannelFlowSummary
, channelFlowSummary_name
- The name of the channel flow.
$sel:processors:ChannelFlowSummary'
, channelFlowSummary_processors
- Information about the processor Lambda functions.
ChannelMembership
data ChannelMembership Source #
The details of a channel member.
See: newChannelMembership
smart constructor.
ChannelMembership' (Maybe Text) (Maybe POSIX) (Maybe Identity) (Maybe POSIX) (Maybe Identity) (Maybe Text) (Maybe ChannelMembershipType) |
Instances
newChannelMembership :: ChannelMembership Source #
Create a value of ChannelMembership
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:channelArn:ChannelMembership'
, channelMembership_channelArn
- The ARN of the member's channel.
$sel:createdTimestamp:ChannelMembership'
, channelMembership_createdTimestamp
- The time at which the channel membership was created.
$sel:invitedBy:ChannelMembership'
, channelMembership_invitedBy
- The identifier of the member who invited another member.
$sel:lastUpdatedTimestamp:ChannelMembership'
, channelMembership_lastUpdatedTimestamp
- The time at which a channel membership was last updated.
$sel:member:ChannelMembership'
, channelMembership_member
- The data of the channel member.
$sel:subChannelId:ChannelMembership'
, channelMembership_subChannelId
- The ID of the SubChannel that a user belongs to.
$sel:type':ChannelMembership'
, channelMembership_type
- The membership type set for the channel member.
ChannelMembershipForAppInstanceUserSummary
data ChannelMembershipForAppInstanceUserSummary Source #
Summary of the channel membership details of an AppInstanceUser
.
See: newChannelMembershipForAppInstanceUserSummary
smart constructor.
ChannelMembershipForAppInstanceUserSummary' (Maybe AppInstanceUserMembershipSummary) (Maybe ChannelSummary) |
Instances
newChannelMembershipForAppInstanceUserSummary :: ChannelMembershipForAppInstanceUserSummary Source #
Create a value of ChannelMembershipForAppInstanceUserSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:appInstanceUserMembershipSummary:ChannelMembershipForAppInstanceUserSummary'
, channelMembershipForAppInstanceUserSummary_appInstanceUserMembershipSummary
- Returns the channel membership data for an AppInstance
.
$sel:channelSummary:ChannelMembershipForAppInstanceUserSummary'
, channelMembershipForAppInstanceUserSummary_channelSummary
- Returns the channel data for an AppInstance
.
ChannelMembershipPreferences
data ChannelMembershipPreferences Source #
The channel membership preferences for an AppInstanceUser
.
See: newChannelMembershipPreferences
smart constructor.
Instances
FromJSON ChannelMembershipPreferences Source # | |
ToJSON ChannelMembershipPreferences Source # | |
Generic ChannelMembershipPreferences Source # | |
Show ChannelMembershipPreferences Source # | |
NFData ChannelMembershipPreferences Source # | |
Eq ChannelMembershipPreferences Source # | |
Hashable ChannelMembershipPreferences Source # | |
type Rep ChannelMembershipPreferences Source # | |
Defined in Amazonka.ChimeSDKMessaging.Types.ChannelMembershipPreferences type Rep ChannelMembershipPreferences = D1 ('MetaData "ChannelMembershipPreferences" "Amazonka.ChimeSDKMessaging.Types.ChannelMembershipPreferences" "amazonka-chime-sdk-messaging-2.0-BxY1AbjLoDB4AQUv82PCQZ" 'False) (C1 ('MetaCons "ChannelMembershipPreferences'" 'PrefixI 'True) (S1 ('MetaSel ('Just "pushNotifications") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PushNotificationPreferences)))) |
newChannelMembershipPreferences :: ChannelMembershipPreferences Source #
Create a value of ChannelMembershipPreferences
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:pushNotifications:ChannelMembershipPreferences'
, channelMembershipPreferences_pushNotifications
- The push notification configuration of a message.
ChannelMembershipSummary
data ChannelMembershipSummary Source #
Summary of the details of a ChannelMembership
.
See: newChannelMembershipSummary
smart constructor.
Instances
newChannelMembershipSummary :: ChannelMembershipSummary Source #
Create a value of ChannelMembershipSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:member:ChannelMembershipSummary'
, channelMembershipSummary_member
- A member's summary data.
ChannelMessage
data ChannelMessage Source #
The details of a message in a channel.
See: newChannelMessage
smart constructor.
ChannelMessage' (Maybe Text) (Maybe (Sensitive Text)) (Maybe POSIX) (Maybe POSIX) (Maybe POSIX) (Maybe (HashMap Text MessageAttributeValue)) (Maybe Text) (Maybe (Sensitive Text)) (Maybe ChannelMessagePersistenceType) (Maybe Bool) (Maybe Identity) (Maybe ChannelMessageStatusStructure) (Maybe Text) (Maybe ChannelMessageType) |
Instances
newChannelMessage :: ChannelMessage Source #
Create a value of ChannelMessage
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:channelArn:ChannelMessage'
, channelMessage_channelArn
- The ARN of the channel.
$sel:content:ChannelMessage'
, channelMessage_content
- The message content.
$sel:createdTimestamp:ChannelMessage'
, channelMessage_createdTimestamp
- The time at which the message was created.
$sel:lastEditedTimestamp:ChannelMessage'
, channelMessage_lastEditedTimestamp
- The time at which a message was edited.
$sel:lastUpdatedTimestamp:ChannelMessage'
, channelMessage_lastUpdatedTimestamp
- The time at which a message was updated.
$sel:messageAttributes:ChannelMessage'
, channelMessage_messageAttributes
- The attributes for the message, used for message filtering along with a
FilterRule
defined in the PushNotificationPreferences
.
$sel:messageId:ChannelMessage'
, channelMessage_messageId
- The ID of a message.
$sel:metadata:ChannelMessage'
, channelMessage_metadata
- The message metadata.
$sel:persistence:ChannelMessage'
, channelMessage_persistence
- The persistence setting for a channel message.
$sel:redacted:ChannelMessage'
, channelMessage_redacted
- Hides the content of a message.
$sel:sender:ChannelMessage'
, channelMessage_sender
- The message sender.
$sel:status:ChannelMessage'
, channelMessage_status
- The status of the channel message.
$sel:subChannelId:ChannelMessage'
, channelMessage_subChannelId
- The ID of the SubChannel.
$sel:type':ChannelMessage'
, channelMessage_type
- The message type.
ChannelMessageCallback
data ChannelMessageCallback Source #
Stores information about a callback.
See: newChannelMessageCallback
smart constructor.
ChannelMessageCallback' (Maybe (Sensitive Text)) (Maybe (HashMap Text MessageAttributeValue)) (Maybe (Sensitive Text)) (Maybe PushNotificationConfiguration) (Maybe Text) Text |
Instances
newChannelMessageCallback Source #
Create a value of ChannelMessageCallback
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:content:ChannelMessageCallback'
, channelMessageCallback_content
- The message content.
$sel:messageAttributes:ChannelMessageCallback'
, channelMessageCallback_messageAttributes
- The attributes for the message, used for message filtering along with a
FilterRule
defined in the PushNotificationPreferences
.
$sel:metadata:ChannelMessageCallback'
, channelMessageCallback_metadata
- The message metadata.
$sel:pushNotification:ChannelMessageCallback'
, channelMessageCallback_pushNotification
- The push notification configuration of the message.
$sel:subChannelId:ChannelMessageCallback'
, channelMessageCallback_subChannelId
- The ID of the SubChannel.
$sel:messageId:ChannelMessageCallback'
, channelMessageCallback_messageId
- The message ID.
ChannelMessageStatusStructure
data ChannelMessageStatusStructure Source #
Stores information about a message status.
See: newChannelMessageStatusStructure
smart constructor.
Instances
FromJSON ChannelMessageStatusStructure Source # | |
Generic ChannelMessageStatusStructure Source # | |
Read ChannelMessageStatusStructure Source # | |
Show ChannelMessageStatusStructure Source # | |
NFData ChannelMessageStatusStructure Source # | |
Eq ChannelMessageStatusStructure Source # | |
Hashable ChannelMessageStatusStructure Source # | |
type Rep ChannelMessageStatusStructure Source # | |
Defined in Amazonka.ChimeSDKMessaging.Types.ChannelMessageStatusStructure type Rep ChannelMessageStatusStructure = D1 ('MetaData "ChannelMessageStatusStructure" "Amazonka.ChimeSDKMessaging.Types.ChannelMessageStatusStructure" "amazonka-chime-sdk-messaging-2.0-BxY1AbjLoDB4AQUv82PCQZ" 'False) (C1 ('MetaCons "ChannelMessageStatusStructure'" 'PrefixI 'True) (S1 ('MetaSel ('Just "detail") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChannelMessageStatus)))) |
newChannelMessageStatusStructure :: ChannelMessageStatusStructure Source #
Create a value of ChannelMessageStatusStructure
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:detail:ChannelMessageStatusStructure'
, channelMessageStatusStructure_detail
- Contains more details about the messasge status.
$sel:value:ChannelMessageStatusStructure'
, channelMessageStatusStructure_value
- The message status value.
ChannelMessageSummary
data ChannelMessageSummary Source #
Summary of the messages in a Channel
.
See: newChannelMessageSummary
smart constructor.
ChannelMessageSummary' (Maybe (Sensitive Text)) (Maybe POSIX) (Maybe POSIX) (Maybe POSIX) (Maybe (HashMap Text MessageAttributeValue)) (Maybe Text) (Maybe (Sensitive Text)) (Maybe Bool) (Maybe Identity) (Maybe ChannelMessageStatusStructure) (Maybe ChannelMessageType) |
Instances
newChannelMessageSummary :: ChannelMessageSummary Source #
Create a value of ChannelMessageSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:content:ChannelMessageSummary'
, channelMessageSummary_content
- The content of the message.
$sel:createdTimestamp:ChannelMessageSummary'
, channelMessageSummary_createdTimestamp
- The time at which the message summary was created.
$sel:lastEditedTimestamp:ChannelMessageSummary'
, channelMessageSummary_lastEditedTimestamp
- The time at which a message was last edited.
$sel:lastUpdatedTimestamp:ChannelMessageSummary'
, channelMessageSummary_lastUpdatedTimestamp
- The time at which a message was last updated.
$sel:messageAttributes:ChannelMessageSummary'
, channelMessageSummary_messageAttributes
- The message attribues listed in a the summary of a channel message.
$sel:messageId:ChannelMessageSummary'
, channelMessageSummary_messageId
- The ID of the message.
$sel:metadata:ChannelMessageSummary'
, channelMessageSummary_metadata
- The metadata of the message.
$sel:redacted:ChannelMessageSummary'
, channelMessageSummary_redacted
- Indicates whether a message was redacted.
$sel:sender:ChannelMessageSummary'
, channelMessageSummary_sender
- The message sender.
$sel:status:ChannelMessageSummary'
, channelMessageSummary_status
- 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.
$sel:type':ChannelMessageSummary'
, channelMessageSummary_type
- The type of message.
ChannelModeratedByAppInstanceUserSummary
data ChannelModeratedByAppInstanceUserSummary Source #
Summary of the details of a moderated channel.
See: newChannelModeratedByAppInstanceUserSummary
smart constructor.
Instances
FromJSON ChannelModeratedByAppInstanceUserSummary Source # | |
Generic ChannelModeratedByAppInstanceUserSummary Source # | |
Show ChannelModeratedByAppInstanceUserSummary Source # | |
NFData ChannelModeratedByAppInstanceUserSummary Source # | |
Eq ChannelModeratedByAppInstanceUserSummary Source # | |
Hashable ChannelModeratedByAppInstanceUserSummary Source # | |
type Rep ChannelModeratedByAppInstanceUserSummary Source # | |
Defined in Amazonka.ChimeSDKMessaging.Types.ChannelModeratedByAppInstanceUserSummary type Rep ChannelModeratedByAppInstanceUserSummary = D1 ('MetaData "ChannelModeratedByAppInstanceUserSummary" "Amazonka.ChimeSDKMessaging.Types.ChannelModeratedByAppInstanceUserSummary" "amazonka-chime-sdk-messaging-2.0-BxY1AbjLoDB4AQUv82PCQZ" 'False) (C1 ('MetaCons "ChannelModeratedByAppInstanceUserSummary'" 'PrefixI 'True) (S1 ('MetaSel ('Just "channelSummary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChannelSummary)))) |
newChannelModeratedByAppInstanceUserSummary :: ChannelModeratedByAppInstanceUserSummary Source #
Create a value of ChannelModeratedByAppInstanceUserSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:channelSummary:ChannelModeratedByAppInstanceUserSummary'
, channelModeratedByAppInstanceUserSummary_channelSummary
- Summary of the details of a Channel
.
ChannelModerator
data ChannelModerator Source #
The details of a channel moderator.
See: newChannelModerator
smart constructor.
Instances
newChannelModerator :: ChannelModerator Source #
Create a value of ChannelModerator
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:channelArn:ChannelModerator'
, channelModerator_channelArn
- The ARN of the moderator's channel.
$sel:createdBy:ChannelModerator'
, channelModerator_createdBy
- The AppInstanceUser
who created the moderator.
$sel:createdTimestamp:ChannelModerator'
, channelModerator_createdTimestamp
- The time at which the moderator was created.
$sel:moderator:ChannelModerator'
, channelModerator_moderator
- The moderator's data.
ChannelModeratorSummary
data ChannelModeratorSummary Source #
Summary of the details of a ChannelModerator
.
See: newChannelModeratorSummary
smart constructor.
Instances
newChannelModeratorSummary :: ChannelModeratorSummary Source #
Create a value of ChannelModeratorSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:moderator:ChannelModeratorSummary'
, channelModeratorSummary_moderator
- The data for a moderator.
ChannelSummary
data ChannelSummary Source #
Summary of the details of a Channel
.
See: newChannelSummary
smart constructor.
ChannelSummary' (Maybe Text) (Maybe POSIX) (Maybe (Sensitive Text)) (Maybe ChannelMode) (Maybe (Sensitive Text)) (Maybe ChannelPrivacy) |
Instances
newChannelSummary :: ChannelSummary Source #
Create a value of ChannelSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:channelArn:ChannelSummary'
, channelSummary_channelArn
- The ARN of the channel.
$sel:lastMessageTimestamp:ChannelSummary'
, channelSummary_lastMessageTimestamp
- The time at which the last persistent message in a channel was sent.
$sel:metadata:ChannelSummary'
, channelSummary_metadata
- The metadata of the channel.
$sel:mode:ChannelSummary'
, channelSummary_mode
- The mode of the channel.
$sel:name:ChannelSummary'
, channelSummary_name
- The name of the channel.
$sel:privacy:ChannelSummary'
, channelSummary_privacy
- The privacy setting of the channel.
ElasticChannelConfiguration
data ElasticChannelConfiguration Source #
The attributes required to configure and create an elastic channel. An elastic channel can support a maximum of 1-million members.
See: newElasticChannelConfiguration
smart constructor.
Instances
newElasticChannelConfiguration Source #
:: Natural | |
-> Natural |
|
-> Natural |
|
-> ElasticChannelConfiguration |
Create a value of ElasticChannelConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maximumSubChannels:ElasticChannelConfiguration'
, elasticChannelConfiguration_maximumSubChannels
- The maximum number of SubChannels that you want to allow in the elastic
channel.
$sel:targetMembershipsPerSubChannel:ElasticChannelConfiguration'
, elasticChannelConfiguration_targetMembershipsPerSubChannel
- The maximum number of members allowed in a SubChannel.
$sel:minimumMembershipPercentage:ElasticChannelConfiguration'
, elasticChannelConfiguration_minimumMembershipPercentage
- The minimum allowed percentage of TargetMembershipsPerSubChannel users.
Ceil of the calculated value is used in balancing members among
SubChannels of the elastic channel.
Identity
The details of a user.
See: newIdentity
smart constructor.
Instances
FromJSON Identity Source # | |
Generic Identity Source # | |
Show Identity Source # | |
NFData Identity Source # | |
Defined in Amazonka.ChimeSDKMessaging.Types.Identity | |
Eq Identity Source # | |
Hashable Identity Source # | |
Defined in Amazonka.ChimeSDKMessaging.Types.Identity | |
type Rep Identity Source # | |
Defined in Amazonka.ChimeSDKMessaging.Types.Identity type Rep Identity = D1 ('MetaData "Identity" "Amazonka.ChimeSDKMessaging.Types.Identity" "amazonka-chime-sdk-messaging-2.0-BxY1AbjLoDB4AQUv82PCQZ" 'False) (C1 ('MetaCons "Identity'" 'PrefixI 'True) (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))))) |
newIdentity :: Identity Source #
Create a value of Identity
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:Identity'
, identity_arn
- The ARN in an Identity.
$sel:name:Identity'
, identity_name
- The name in an Identity.
LambdaConfiguration
data LambdaConfiguration Source #
Stores metadata about a Lambda processor.
See: newLambdaConfiguration
smart constructor.
Instances
newLambdaConfiguration Source #
Create a value of LambdaConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:LambdaConfiguration'
, lambdaConfiguration_resourceArn
- The ARN of the Lambda message processing function.
$sel:invocationType:LambdaConfiguration'
, lambdaConfiguration_invocationType
- Controls how the Lambda function is invoked.
MessageAttributeValue
data MessageAttributeValue Source #
A list of message attribute values.
See: newMessageAttributeValue
smart constructor.
Instances
newMessageAttributeValue :: MessageAttributeValue Source #
Create a value of MessageAttributeValue
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:stringValues:MessageAttributeValue'
, messageAttributeValue_stringValues
- The strings in a message attribute value.
MessagingSessionEndpoint
data MessagingSessionEndpoint Source #
The websocket endpoint used to connect to Amazon Chime SDK messaging.
See: newMessagingSessionEndpoint
smart constructor.
Instances
newMessagingSessionEndpoint :: MessagingSessionEndpoint Source #
Create a value of MessagingSessionEndpoint
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:url:MessagingSessionEndpoint'
, messagingSessionEndpoint_url
- The endpoint to which you establish a websocket connection.
Processor
The information about a processor in a channel flow.
See: newProcessor
smart constructor.
Instances
:: Text | |
-> ProcessorConfiguration | |
-> Natural | |
-> FallbackAction | |
-> Processor |
Create a value of Processor
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:Processor'
, processor_name
- The name of the channel flow.
$sel:configuration:Processor'
, processor_configuration
- The information about the type of processor and its identifier.
$sel:executionOrder:Processor'
, processor_executionOrder
- 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.
$sel:fallbackAction:Processor'
, processor_fallbackAction
- 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
data ProcessorConfiguration Source #
A processor's metadata.
See: newProcessorConfiguration
smart constructor.
Instances
newProcessorConfiguration Source #
Create a value of ProcessorConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:lambda:ProcessorConfiguration'
, processorConfiguration_lambda
- Indicates that the processor is of type Lambda.
PushNotificationConfiguration
data PushNotificationConfiguration Source #
The push notification configuration of the message.
See: newPushNotificationConfiguration
smart constructor.
PushNotificationConfiguration' (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe PushNotificationType) |
Instances
newPushNotificationConfiguration :: PushNotificationConfiguration Source #
Create a value of PushNotificationConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:body:PushNotificationConfiguration'
, pushNotificationConfiguration_body
- The body of the push notification.
$sel:title:PushNotificationConfiguration'
, pushNotificationConfiguration_title
- The title of the push notification.
$sel:type':PushNotificationConfiguration'
, pushNotificationConfiguration_type
- Enum value that indicates the type of the push notification for a
message. DEFAULT
: Normal mobile push notification. VOIP
: VOIP mobile
push notification.
PushNotificationPreferences
data PushNotificationPreferences Source #
The channel membership preferences for push notification.
See: newPushNotificationPreferences
smart constructor.
Instances
newPushNotificationPreferences Source #
Create a value of PushNotificationPreferences
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filterRule:PushNotificationPreferences'
, pushNotificationPreferences_filterRule
- The simple JSON object used to send a subset of a push notification to
the requested member.
$sel:allowNotifications:PushNotificationPreferences'
, pushNotificationPreferences_allowNotifications
- 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
data SearchField Source #
A Field
of the channel that you want to search.
See: newSearchField
smart constructor.
Instances
Create a value of SearchField
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:key:SearchField'
, searchField_key
- 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.
$sel:values:SearchField'
, searchField_values
- 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.
$sel:operator:SearchField'
, searchField_operator
- 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
data SubChannelSummary Source #
Summary of the sub-channels associated with the elastic channel.
See: newSubChannelSummary
smart constructor.
Instances
newSubChannelSummary :: SubChannelSummary Source #
Create a value of SubChannelSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:membershipCount:SubChannelSummary'
, subChannelSummary_membershipCount
- The number of members in a SubChannel.
$sel:subChannelId:SubChannelSummary'
, subChannelSummary_subChannelId
- The unique ID of a SubChannel.
Tag
A tag object containing a key-value pair.
See: newTag
smart constructor.
Instances
FromJSON Tag Source # | |
ToJSON Tag Source # | |
Defined in Amazonka.ChimeSDKMessaging.Types.Tag | |
Generic Tag Source # | |
Show Tag Source # | |
NFData Tag Source # | |
Defined in Amazonka.ChimeSDKMessaging.Types.Tag | |
Eq Tag Source # | |
Hashable Tag Source # | |
Defined in Amazonka.ChimeSDKMessaging.Types.Tag | |
type Rep Tag Source # | |
Defined in Amazonka.ChimeSDKMessaging.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.ChimeSDKMessaging.Types.Tag" "amazonka-chime-sdk-messaging-2.0-BxY1AbjLoDB4AQUv82PCQZ" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)))) |
Create a value of Tag
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:key:Tag'
, tag_key
- The key in a tag.
$sel:value:Tag'
, tag_value
- The value in a tag.