| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.ChimeSDKMessaging.Types
Contents
- Service Configuration
- Errors
- 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
Description
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
- 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' {}
- newAppInstanceUserMembershipSummary :: AppInstanceUserMembershipSummary
- appInstanceUserMembershipSummary_readMarkerTimestamp :: Lens' AppInstanceUserMembershipSummary (Maybe UTCTime)
- appInstanceUserMembershipSummary_subChannelId :: Lens' AppInstanceUserMembershipSummary (Maybe Text)
- appInstanceUserMembershipSummary_type :: Lens' AppInstanceUserMembershipSummary (Maybe ChannelMembershipType)
- data BatchChannelMemberships = BatchChannelMemberships' {}
- newBatchChannelMemberships :: BatchChannelMemberships
- batchChannelMemberships_channelArn :: Lens' BatchChannelMemberships (Maybe Text)
- batchChannelMemberships_invitedBy :: Lens' BatchChannelMemberships (Maybe Identity)
- batchChannelMemberships_members :: Lens' BatchChannelMemberships (Maybe [Identity])
- batchChannelMemberships_subChannelId :: Lens' BatchChannelMemberships (Maybe Text)
- batchChannelMemberships_type :: Lens' BatchChannelMemberships (Maybe ChannelMembershipType)
- data BatchCreateChannelMembershipError = BatchCreateChannelMembershipError' {}
- newBatchCreateChannelMembershipError :: BatchCreateChannelMembershipError
- batchCreateChannelMembershipError_errorCode :: Lens' BatchCreateChannelMembershipError (Maybe ErrorCode)
- batchCreateChannelMembershipError_errorMessage :: Lens' BatchCreateChannelMembershipError (Maybe Text)
- batchCreateChannelMembershipError_memberArn :: Lens' BatchCreateChannelMembershipError (Maybe Text)
- data Channel = Channel' {
- channelArn :: Maybe Text
- channelFlowArn :: Maybe Text
- createdBy :: Maybe Identity
- createdTimestamp :: Maybe POSIX
- elasticChannelConfiguration :: Maybe ElasticChannelConfiguration
- lastMessageTimestamp :: Maybe POSIX
- lastUpdatedTimestamp :: Maybe POSIX
- metadata :: Maybe (Sensitive Text)
- mode :: Maybe ChannelMode
- name :: Maybe (Sensitive Text)
- privacy :: Maybe ChannelPrivacy
- newChannel :: Channel
- channel_channelArn :: Lens' Channel (Maybe Text)
- channel_channelFlowArn :: Lens' Channel (Maybe Text)
- channel_createdBy :: Lens' Channel (Maybe Identity)
- channel_createdTimestamp :: Lens' Channel (Maybe UTCTime)
- channel_elasticChannelConfiguration :: Lens' Channel (Maybe ElasticChannelConfiguration)
- channel_lastMessageTimestamp :: Lens' Channel (Maybe UTCTime)
- channel_lastUpdatedTimestamp :: Lens' Channel (Maybe UTCTime)
- channel_metadata :: Lens' Channel (Maybe Text)
- channel_mode :: Lens' Channel (Maybe ChannelMode)
- channel_name :: Lens' Channel (Maybe Text)
- channel_privacy :: Lens' Channel (Maybe ChannelPrivacy)
- data ChannelAssociatedWithFlowSummary = ChannelAssociatedWithFlowSummary' {}
- newChannelAssociatedWithFlowSummary :: ChannelAssociatedWithFlowSummary
- channelAssociatedWithFlowSummary_channelArn :: Lens' ChannelAssociatedWithFlowSummary (Maybe Text)
- channelAssociatedWithFlowSummary_metadata :: Lens' ChannelAssociatedWithFlowSummary (Maybe Text)
- channelAssociatedWithFlowSummary_mode :: Lens' ChannelAssociatedWithFlowSummary (Maybe ChannelMode)
- channelAssociatedWithFlowSummary_name :: Lens' ChannelAssociatedWithFlowSummary (Maybe Text)
- channelAssociatedWithFlowSummary_privacy :: Lens' ChannelAssociatedWithFlowSummary (Maybe ChannelPrivacy)
- data ChannelBan = ChannelBan' {}
- newChannelBan :: ChannelBan
- channelBan_channelArn :: Lens' ChannelBan (Maybe Text)
- channelBan_createdBy :: Lens' ChannelBan (Maybe Identity)
- channelBan_createdTimestamp :: Lens' ChannelBan (Maybe UTCTime)
- channelBan_member :: Lens' ChannelBan (Maybe Identity)
- data ChannelBanSummary = ChannelBanSummary' {}
- newChannelBanSummary :: ChannelBanSummary
- channelBanSummary_member :: Lens' ChannelBanSummary (Maybe Identity)
- data ChannelFlow = ChannelFlow' {}
- newChannelFlow :: ChannelFlow
- channelFlow_channelFlowArn :: Lens' ChannelFlow (Maybe Text)
- channelFlow_createdTimestamp :: Lens' ChannelFlow (Maybe UTCTime)
- channelFlow_lastUpdatedTimestamp :: Lens' ChannelFlow (Maybe UTCTime)
- channelFlow_name :: Lens' ChannelFlow (Maybe Text)
- channelFlow_processors :: Lens' ChannelFlow (Maybe (NonEmpty Processor))
- data ChannelFlowSummary = ChannelFlowSummary' {}
- newChannelFlowSummary :: ChannelFlowSummary
- channelFlowSummary_channelFlowArn :: Lens' ChannelFlowSummary (Maybe Text)
- channelFlowSummary_name :: Lens' ChannelFlowSummary (Maybe Text)
- channelFlowSummary_processors :: Lens' ChannelFlowSummary (Maybe (NonEmpty Processor))
- data ChannelMembership = ChannelMembership' {}
- newChannelMembership :: ChannelMembership
- channelMembership_channelArn :: Lens' ChannelMembership (Maybe Text)
- channelMembership_createdTimestamp :: Lens' ChannelMembership (Maybe UTCTime)
- channelMembership_invitedBy :: Lens' ChannelMembership (Maybe Identity)
- channelMembership_lastUpdatedTimestamp :: Lens' ChannelMembership (Maybe UTCTime)
- channelMembership_member :: Lens' ChannelMembership (Maybe Identity)
- channelMembership_subChannelId :: Lens' ChannelMembership (Maybe Text)
- channelMembership_type :: Lens' ChannelMembership (Maybe ChannelMembershipType)
- data ChannelMembershipForAppInstanceUserSummary = ChannelMembershipForAppInstanceUserSummary' {}
- newChannelMembershipForAppInstanceUserSummary :: ChannelMembershipForAppInstanceUserSummary
- channelMembershipForAppInstanceUserSummary_appInstanceUserMembershipSummary :: Lens' ChannelMembershipForAppInstanceUserSummary (Maybe AppInstanceUserMembershipSummary)
- channelMembershipForAppInstanceUserSummary_channelSummary :: Lens' ChannelMembershipForAppInstanceUserSummary (Maybe ChannelSummary)
- data ChannelMembershipPreferences = ChannelMembershipPreferences' {}
- newChannelMembershipPreferences :: ChannelMembershipPreferences
- channelMembershipPreferences_pushNotifications :: Lens' ChannelMembershipPreferences (Maybe PushNotificationPreferences)
- data ChannelMembershipSummary = ChannelMembershipSummary' {}
- newChannelMembershipSummary :: ChannelMembershipSummary
- channelMembershipSummary_member :: Lens' ChannelMembershipSummary (Maybe Identity)
- data ChannelMessage = ChannelMessage' {
- channelArn :: Maybe Text
- content :: Maybe (Sensitive Text)
- createdTimestamp :: Maybe POSIX
- lastEditedTimestamp :: Maybe POSIX
- lastUpdatedTimestamp :: Maybe POSIX
- messageAttributes :: Maybe (HashMap Text MessageAttributeValue)
- messageId :: Maybe Text
- metadata :: Maybe (Sensitive Text)
- persistence :: Maybe ChannelMessagePersistenceType
- redacted :: Maybe Bool
- sender :: Maybe Identity
- status :: Maybe ChannelMessageStatusStructure
- subChannelId :: Maybe Text
- type' :: Maybe ChannelMessageType
- newChannelMessage :: ChannelMessage
- channelMessage_channelArn :: Lens' ChannelMessage (Maybe Text)
- channelMessage_content :: Lens' ChannelMessage (Maybe Text)
- channelMessage_createdTimestamp :: Lens' ChannelMessage (Maybe UTCTime)
- channelMessage_lastEditedTimestamp :: Lens' ChannelMessage (Maybe UTCTime)
- channelMessage_lastUpdatedTimestamp :: Lens' ChannelMessage (Maybe UTCTime)
- channelMessage_messageAttributes :: Lens' ChannelMessage (Maybe (HashMap Text MessageAttributeValue))
- channelMessage_messageId :: Lens' ChannelMessage (Maybe Text)
- channelMessage_metadata :: Lens' ChannelMessage (Maybe Text)
- channelMessage_persistence :: Lens' ChannelMessage (Maybe ChannelMessagePersistenceType)
- channelMessage_redacted :: Lens' ChannelMessage (Maybe Bool)
- channelMessage_sender :: Lens' ChannelMessage (Maybe Identity)
- channelMessage_status :: Lens' ChannelMessage (Maybe ChannelMessageStatusStructure)
- channelMessage_subChannelId :: Lens' ChannelMessage (Maybe Text)
- channelMessage_type :: Lens' ChannelMessage (Maybe ChannelMessageType)
- data ChannelMessageCallback = ChannelMessageCallback' {}
- newChannelMessageCallback :: Text -> ChannelMessageCallback
- channelMessageCallback_content :: Lens' ChannelMessageCallback (Maybe Text)
- channelMessageCallback_messageAttributes :: Lens' ChannelMessageCallback (Maybe (HashMap Text MessageAttributeValue))
- channelMessageCallback_metadata :: Lens' ChannelMessageCallback (Maybe Text)
- channelMessageCallback_pushNotification :: Lens' ChannelMessageCallback (Maybe PushNotificationConfiguration)
- channelMessageCallback_subChannelId :: Lens' ChannelMessageCallback (Maybe Text)
- channelMessageCallback_messageId :: Lens' ChannelMessageCallback Text
- data ChannelMessageStatusStructure = ChannelMessageStatusStructure' {}
- newChannelMessageStatusStructure :: ChannelMessageStatusStructure
- channelMessageStatusStructure_detail :: Lens' ChannelMessageStatusStructure (Maybe Text)
- channelMessageStatusStructure_value :: Lens' ChannelMessageStatusStructure (Maybe ChannelMessageStatus)
- data ChannelMessageSummary = ChannelMessageSummary' {
- content :: Maybe (Sensitive Text)
- createdTimestamp :: Maybe POSIX
- lastEditedTimestamp :: Maybe POSIX
- lastUpdatedTimestamp :: Maybe POSIX
- messageAttributes :: Maybe (HashMap Text MessageAttributeValue)
- messageId :: Maybe Text
- metadata :: Maybe (Sensitive Text)
- redacted :: Maybe Bool
- sender :: Maybe Identity
- status :: Maybe ChannelMessageStatusStructure
- type' :: Maybe ChannelMessageType
- newChannelMessageSummary :: ChannelMessageSummary
- channelMessageSummary_content :: Lens' ChannelMessageSummary (Maybe Text)
- channelMessageSummary_createdTimestamp :: Lens' ChannelMessageSummary (Maybe UTCTime)
- channelMessageSummary_lastEditedTimestamp :: Lens' ChannelMessageSummary (Maybe UTCTime)
- channelMessageSummary_lastUpdatedTimestamp :: Lens' ChannelMessageSummary (Maybe UTCTime)
- channelMessageSummary_messageAttributes :: Lens' ChannelMessageSummary (Maybe (HashMap Text MessageAttributeValue))
- channelMessageSummary_messageId :: Lens' ChannelMessageSummary (Maybe Text)
- channelMessageSummary_metadata :: Lens' ChannelMessageSummary (Maybe Text)
- channelMessageSummary_redacted :: Lens' ChannelMessageSummary (Maybe Bool)
- channelMessageSummary_sender :: Lens' ChannelMessageSummary (Maybe Identity)
- channelMessageSummary_status :: Lens' ChannelMessageSummary (Maybe ChannelMessageStatusStructure)
- channelMessageSummary_type :: Lens' ChannelMessageSummary (Maybe ChannelMessageType)
- data ChannelModeratedByAppInstanceUserSummary = ChannelModeratedByAppInstanceUserSummary' {}
- newChannelModeratedByAppInstanceUserSummary :: ChannelModeratedByAppInstanceUserSummary
- channelModeratedByAppInstanceUserSummary_channelSummary :: Lens' ChannelModeratedByAppInstanceUserSummary (Maybe ChannelSummary)
- data ChannelModerator = ChannelModerator' {}
- newChannelModerator :: ChannelModerator
- channelModerator_channelArn :: Lens' ChannelModerator (Maybe Text)
- channelModerator_createdBy :: Lens' ChannelModerator (Maybe Identity)
- channelModerator_createdTimestamp :: Lens' ChannelModerator (Maybe UTCTime)
- channelModerator_moderator :: Lens' ChannelModerator (Maybe Identity)
- data ChannelModeratorSummary = ChannelModeratorSummary' {}
- newChannelModeratorSummary :: ChannelModeratorSummary
- channelModeratorSummary_moderator :: Lens' ChannelModeratorSummary (Maybe Identity)
- data ChannelSummary = ChannelSummary' {
- channelArn :: Maybe Text
- lastMessageTimestamp :: Maybe POSIX
- metadata :: Maybe (Sensitive Text)
- mode :: Maybe ChannelMode
- name :: Maybe (Sensitive Text)
- privacy :: Maybe ChannelPrivacy
- newChannelSummary :: ChannelSummary
- channelSummary_channelArn :: Lens' ChannelSummary (Maybe Text)
- channelSummary_lastMessageTimestamp :: Lens' ChannelSummary (Maybe UTCTime)
- channelSummary_metadata :: Lens' ChannelSummary (Maybe Text)
- channelSummary_mode :: Lens' ChannelSummary (Maybe ChannelMode)
- channelSummary_name :: Lens' ChannelSummary (Maybe Text)
- channelSummary_privacy :: Lens' ChannelSummary (Maybe ChannelPrivacy)
- data ElasticChannelConfiguration = ElasticChannelConfiguration' {}
- newElasticChannelConfiguration :: Natural -> Natural -> Natural -> ElasticChannelConfiguration
- elasticChannelConfiguration_maximumSubChannels :: Lens' ElasticChannelConfiguration Natural
- elasticChannelConfiguration_targetMembershipsPerSubChannel :: Lens' ElasticChannelConfiguration Natural
- elasticChannelConfiguration_minimumMembershipPercentage :: Lens' ElasticChannelConfiguration Natural
- data Identity = Identity' {}
- newIdentity :: Identity
- identity_arn :: Lens' Identity (Maybe Text)
- identity_name :: Lens' Identity (Maybe Text)
- data LambdaConfiguration = LambdaConfiguration' {}
- newLambdaConfiguration :: Text -> InvocationType -> LambdaConfiguration
- lambdaConfiguration_resourceArn :: Lens' LambdaConfiguration Text
- lambdaConfiguration_invocationType :: Lens' LambdaConfiguration InvocationType
- data MessageAttributeValue = MessageAttributeValue' {
- stringValues :: Maybe [Sensitive Text]
- newMessageAttributeValue :: MessageAttributeValue
- messageAttributeValue_stringValues :: Lens' MessageAttributeValue (Maybe [Text])
- data MessagingSessionEndpoint = MessagingSessionEndpoint' {}
- newMessagingSessionEndpoint :: MessagingSessionEndpoint
- messagingSessionEndpoint_url :: Lens' MessagingSessionEndpoint (Maybe Text)
- data Processor = Processor' {}
- newProcessor :: Text -> ProcessorConfiguration -> Natural -> FallbackAction -> Processor
- processor_name :: Lens' Processor Text
- processor_configuration :: Lens' Processor ProcessorConfiguration
- processor_executionOrder :: Lens' Processor Natural
- processor_fallbackAction :: Lens' Processor FallbackAction
- data ProcessorConfiguration = ProcessorConfiguration' {}
- newProcessorConfiguration :: LambdaConfiguration -> ProcessorConfiguration
- processorConfiguration_lambda :: Lens' ProcessorConfiguration LambdaConfiguration
- data PushNotificationConfiguration = PushNotificationConfiguration' {}
- newPushNotificationConfiguration :: PushNotificationConfiguration
- pushNotificationConfiguration_body :: Lens' PushNotificationConfiguration (Maybe Text)
- pushNotificationConfiguration_title :: Lens' PushNotificationConfiguration (Maybe Text)
- pushNotificationConfiguration_type :: Lens' PushNotificationConfiguration (Maybe PushNotificationType)
- data PushNotificationPreferences = PushNotificationPreferences' {}
- newPushNotificationPreferences :: AllowNotifications -> PushNotificationPreferences
- pushNotificationPreferences_filterRule :: Lens' PushNotificationPreferences (Maybe Text)
- pushNotificationPreferences_allowNotifications :: Lens' PushNotificationPreferences AllowNotifications
- data SearchField = SearchField' {}
- newSearchField :: SearchFieldKey -> NonEmpty Text -> SearchFieldOperator -> SearchField
- searchField_key :: Lens' SearchField SearchFieldKey
- searchField_values :: Lens' SearchField (NonEmpty Text)
- searchField_operator :: Lens' SearchField SearchFieldOperator
- data SubChannelSummary = SubChannelSummary' {}
- newSubChannelSummary :: SubChannelSummary
- subChannelSummary_membershipCount :: Lens' SubChannelSummary (Maybe Int)
- subChannelSummary_subChannelId :: Lens' SubChannelSummary (Maybe Text)
- data Tag = Tag' {}
- newTag :: Text -> Text -> Tag
- tag_key :: Lens' Tag Text
- tag_value :: Lens' Tag Text
Service Configuration
defaultService :: Service Source #
API version 2021-05-15 of the Amazon Chime SDK Messaging SDK configuration.
Errors
_BadRequestException :: AsError a => Fold a ServiceError Source #
The input parameters don't match the service's restrictions.
_ConflictException :: AsError a => Fold a ServiceError Source #
The request could not be processed because of conflict in the current state of the resource.
_ForbiddenException :: AsError a => Fold a ServiceError Source #
The client is permanently forbidden from making the request.
_NotFoundException :: AsError a => Fold a ServiceError Source #
One or more of the resources in the request does not exist in the system.
_ResourceLimitExceededException :: AsError a => Fold a ServiceError Source #
The request exceeds the resource limit.
_ServiceFailureException :: AsError a => Fold a ServiceError Source #
The service encountered an unexpected error.
_ServiceUnavailableException :: AsError a => Fold a ServiceError Source #
The service is currently unavailable.
_ThrottledClientException :: AsError a => Fold a ServiceError Source #
The client exceeded its request rate limit.
_UnauthorizedClientException :: AsError a => Fold a ServiceError Source #
The client is not currently authorized to make the request.
AllowNotifications
newtype AllowNotifications Source #
Constructors
| AllowNotifications' | |
Fields | |
Bundled Patterns
| pattern AllowNotifications_ALL :: AllowNotifications | |
| pattern AllowNotifications_FILTERED :: AllowNotifications | |
| pattern AllowNotifications_NONE :: AllowNotifications |
Instances
ChannelMembershipType
newtype ChannelMembershipType Source #
Constructors
| ChannelMembershipType' | |
Fields | |
Bundled Patterns
| pattern ChannelMembershipType_DEFAULT :: ChannelMembershipType | |
| pattern ChannelMembershipType_HIDDEN :: ChannelMembershipType |
Instances
ChannelMessagePersistenceType
newtype ChannelMessagePersistenceType Source #
Constructors
| ChannelMessagePersistenceType' | |
Fields | |
Bundled Patterns
| pattern ChannelMessagePersistenceType_NON_PERSISTENT :: ChannelMessagePersistenceType | |
| pattern ChannelMessagePersistenceType_PERSISTENT :: ChannelMessagePersistenceType |
Instances
ChannelMessageStatus
newtype ChannelMessageStatus Source #
Constructors
| ChannelMessageStatus' | |
Fields | |
Bundled Patterns
| pattern ChannelMessageStatus_DENIED :: ChannelMessageStatus | |
| pattern ChannelMessageStatus_FAILED :: ChannelMessageStatus | |
| pattern ChannelMessageStatus_PENDING :: ChannelMessageStatus | |
| pattern ChannelMessageStatus_SENT :: ChannelMessageStatus |
Instances
ChannelMessageType
newtype ChannelMessageType Source #
Constructors
| ChannelMessageType' | |
Fields | |
Bundled Patterns
| pattern ChannelMessageType_CONTROL :: ChannelMessageType | |
| pattern ChannelMessageType_STANDARD :: ChannelMessageType |
Instances
ChannelMode
newtype ChannelMode Source #
Constructors
| ChannelMode' | |
Fields | |
Bundled Patterns
| pattern ChannelMode_RESTRICTED :: ChannelMode | |
| pattern ChannelMode_UNRESTRICTED :: ChannelMode |
Instances
ChannelPrivacy
newtype ChannelPrivacy Source #
Constructors
| ChannelPrivacy' | |
Fields | |
Bundled Patterns
| pattern ChannelPrivacy_PRIVATE :: ChannelPrivacy | |
| pattern ChannelPrivacy_PUBLIC :: ChannelPrivacy |
Instances
ErrorCode
Constructors
| ErrorCode' | |
Fields | |
Bundled Patterns
| 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 #
Constructors
| FallbackAction' | |
Fields | |
Bundled Patterns
| pattern FallbackAction_ABORT :: FallbackAction | |
| pattern FallbackAction_CONTINUE :: FallbackAction |
Instances
InvocationType
newtype InvocationType Source #
Constructors
| InvocationType' | |
Fields | |
Bundled Patterns
| pattern InvocationType_ASYNC :: InvocationType |
Instances
PushNotificationType
newtype PushNotificationType Source #
Constructors
| PushNotificationType' | |
Fields | |
Bundled Patterns
| pattern PushNotificationType_DEFAULT :: PushNotificationType | |
| pattern PushNotificationType_VOIP :: PushNotificationType |
Instances
SearchFieldKey
newtype SearchFieldKey Source #
Constructors
| SearchFieldKey' | |
Fields | |
Bundled Patterns
| pattern SearchFieldKey_MEMBERS :: SearchFieldKey |
Instances
SearchFieldOperator
newtype SearchFieldOperator Source #
Constructors
| SearchFieldOperator' | |
Fields | |
Bundled Patterns
| pattern SearchFieldOperator_EQUALS :: SearchFieldOperator | |
| pattern SearchFieldOperator_INCLUDES :: SearchFieldOperator |
Instances
SortOrder
Constructors
| SortOrder' | |
Fields | |
Bundled Patterns
| 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.
Constructors
| AppInstanceUserMembershipSummary' | |
Fields
| |
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.
appInstanceUserMembershipSummary_readMarkerTimestamp :: Lens' AppInstanceUserMembershipSummary (Maybe UTCTime) Source #
The time at which an AppInstanceUser last marked a channel as read.
appInstanceUserMembershipSummary_subChannelId :: Lens' AppInstanceUserMembershipSummary (Maybe Text) Source #
The ID of the SubChannel that the AppInstanceUser is a member of.
appInstanceUserMembershipSummary_type :: Lens' AppInstanceUserMembershipSummary (Maybe ChannelMembershipType) Source #
The type of ChannelMembership.
BatchChannelMemberships
data BatchChannelMemberships Source #
The membership information, including member ARNs, the channel ARN, and membership types.
See: newBatchChannelMemberships smart constructor.
Constructors
| BatchChannelMemberships' | |
Fields
| |
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.
batchChannelMemberships_channelArn :: Lens' BatchChannelMemberships (Maybe Text) Source #
The ARN of the channel to which you're adding users.
batchChannelMemberships_invitedBy :: Lens' BatchChannelMemberships (Maybe Identity) Source #
The identifier of the member who invited another member.
batchChannelMemberships_members :: Lens' BatchChannelMemberships (Maybe [Identity]) Source #
The users successfully added to the request.
batchChannelMemberships_subChannelId :: Lens' BatchChannelMemberships (Maybe Text) Source #
The ID of the SubChannel.
batchChannelMemberships_type :: Lens' BatchChannelMemberships (Maybe ChannelMembershipType) Source #
The membership types set for the channel users.
BatchCreateChannelMembershipError
data BatchCreateChannelMembershipError Source #
A list of failed member ARNs, error codes, and error messages.
See: newBatchCreateChannelMembershipError smart constructor.
Constructors
| BatchCreateChannelMembershipError' | |
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.
batchCreateChannelMembershipError_errorCode :: Lens' BatchCreateChannelMembershipError (Maybe ErrorCode) Source #
The error code.
batchCreateChannelMembershipError_errorMessage :: Lens' BatchCreateChannelMembershipError (Maybe Text) Source #
The error message.
batchCreateChannelMembershipError_memberArn :: Lens' BatchCreateChannelMembershipError (Maybe Text) Source #
The AppInstanceUserArn of the member that the service couldn't add.
Channel
The details of a channel.
See: newChannel smart constructor.
Constructors
| Channel' | |
Fields
| |
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.
channel_createdBy :: Lens' Channel (Maybe Identity) Source #
The AppInstanceUser who created the channel.
channel_createdTimestamp :: Lens' Channel (Maybe UTCTime) Source #
The time at which the AppInstanceUser created the channel.
channel_elasticChannelConfiguration :: Lens' Channel (Maybe ElasticChannelConfiguration) Source #
The attributes required to configure and create an elastic channel. An elastic channel can support a maximum of 1-million members.
channel_lastMessageTimestamp :: Lens' Channel (Maybe UTCTime) Source #
The time at which a member sent the last message in the channel.
channel_lastUpdatedTimestamp :: Lens' Channel (Maybe UTCTime) Source #
The time at which a channel was last updated.
channel_mode :: Lens' Channel (Maybe ChannelMode) Source #
The mode of the channel.
channel_privacy :: Lens' Channel (Maybe ChannelPrivacy) Source #
The channel's privacy setting.
ChannelAssociatedWithFlowSummary
data ChannelAssociatedWithFlowSummary Source #
Summary of details of a channel associated with channel flow.
See: newChannelAssociatedWithFlowSummary smart constructor.
Constructors
| ChannelAssociatedWithFlowSummary' | |
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.
channelAssociatedWithFlowSummary_channelArn :: Lens' ChannelAssociatedWithFlowSummary (Maybe Text) Source #
The ARN of the channel.
channelAssociatedWithFlowSummary_metadata :: Lens' ChannelAssociatedWithFlowSummary (Maybe Text) Source #
The channel's metadata.
channelAssociatedWithFlowSummary_mode :: Lens' ChannelAssociatedWithFlowSummary (Maybe ChannelMode) Source #
The mode of the channel.
channelAssociatedWithFlowSummary_name :: Lens' ChannelAssociatedWithFlowSummary (Maybe Text) Source #
The name of the channel flow.
channelAssociatedWithFlowSummary_privacy :: Lens' ChannelAssociatedWithFlowSummary (Maybe ChannelPrivacy) Source #
The channel's privacy setting.
ChannelBan
data ChannelBan Source #
The details of a channel ban.
See: newChannelBan smart constructor.
Constructors
| ChannelBan' | |
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.
channelBan_channelArn :: Lens' ChannelBan (Maybe Text) Source #
The ARN of the channel from which a member is being banned.
channelBan_createdBy :: Lens' ChannelBan (Maybe Identity) Source #
The AppInstanceUser who created the ban.
channelBan_createdTimestamp :: Lens' ChannelBan (Maybe UTCTime) Source #
The time at which the ban was created.
channelBan_member :: Lens' ChannelBan (Maybe Identity) Source #
The member being banned from the channel.
ChannelBanSummary
data ChannelBanSummary Source #
Summary of the details of a ChannelBan.
See: newChannelBanSummary smart constructor.
Constructors
| ChannelBanSummary' | |
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.
channelBanSummary_member :: Lens' ChannelBanSummary (Maybe Identity) Source #
The member being banned from a channel.
ChannelFlow
data ChannelFlow Source #
The details of a channel flow.
See: newChannelFlow smart constructor.
Constructors
| ChannelFlow' | |
Fields
| |
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.
channelFlow_channelFlowArn :: Lens' ChannelFlow (Maybe Text) Source #
The ARN of the channel flow.
channelFlow_createdTimestamp :: Lens' ChannelFlow (Maybe UTCTime) Source #
The time at which the channel flow was created.
channelFlow_lastUpdatedTimestamp :: Lens' ChannelFlow (Maybe UTCTime) Source #
The time at which a channel flow was updated.
channelFlow_name :: Lens' ChannelFlow (Maybe Text) Source #
The name of the channel flow.
channelFlow_processors :: Lens' ChannelFlow (Maybe (NonEmpty Processor)) Source #
Information about the processor Lambda functions.
ChannelFlowSummary
data ChannelFlowSummary Source #
Summary of details of a channel flow.
See: newChannelFlowSummary smart constructor.
Constructors
| ChannelFlowSummary' | |
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.
channelFlowSummary_channelFlowArn :: Lens' ChannelFlowSummary (Maybe Text) Source #
The ARN of the channel flow.
channelFlowSummary_name :: Lens' ChannelFlowSummary (Maybe Text) Source #
The name of the channel flow.
channelFlowSummary_processors :: Lens' ChannelFlowSummary (Maybe (NonEmpty Processor)) Source #
Information about the processor Lambda functions.
ChannelMembership
data ChannelMembership Source #
The details of a channel member.
See: newChannelMembership smart constructor.
Constructors
| ChannelMembership' | |
Fields
| |
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.
channelMembership_channelArn :: Lens' ChannelMembership (Maybe Text) Source #
The ARN of the member's channel.
channelMembership_createdTimestamp :: Lens' ChannelMembership (Maybe UTCTime) Source #
The time at which the channel membership was created.
channelMembership_invitedBy :: Lens' ChannelMembership (Maybe Identity) Source #
The identifier of the member who invited another member.
channelMembership_lastUpdatedTimestamp :: Lens' ChannelMembership (Maybe UTCTime) Source #
The time at which a channel membership was last updated.
channelMembership_member :: Lens' ChannelMembership (Maybe Identity) Source #
The data of the channel member.
channelMembership_subChannelId :: Lens' ChannelMembership (Maybe Text) Source #
The ID of the SubChannel that a user belongs to.
channelMembership_type :: Lens' ChannelMembership (Maybe ChannelMembershipType) Source #
The membership type set for the channel member.
ChannelMembershipForAppInstanceUserSummary
data ChannelMembershipForAppInstanceUserSummary Source #
Summary of the channel membership details of an AppInstanceUser.
See: newChannelMembershipForAppInstanceUserSummary smart constructor.
Constructors
| ChannelMembershipForAppInstanceUserSummary' | |
Fields
| |
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.
channelMembershipForAppInstanceUserSummary_appInstanceUserMembershipSummary :: Lens' ChannelMembershipForAppInstanceUserSummary (Maybe AppInstanceUserMembershipSummary) Source #
Returns the channel membership data for an AppInstance.
channelMembershipForAppInstanceUserSummary_channelSummary :: Lens' ChannelMembershipForAppInstanceUserSummary (Maybe ChannelSummary) Source #
Returns the channel data for an AppInstance.
ChannelMembershipPreferences
data ChannelMembershipPreferences Source #
The channel membership preferences for an AppInstanceUser.
See: newChannelMembershipPreferences smart constructor.
Constructors
| ChannelMembershipPreferences' | |
Fields
| |
Instances
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.
channelMembershipPreferences_pushNotifications :: Lens' ChannelMembershipPreferences (Maybe PushNotificationPreferences) Source #
The push notification configuration of a message.
ChannelMembershipSummary
data ChannelMembershipSummary Source #
Summary of the details of a ChannelMembership.
See: newChannelMembershipSummary smart constructor.
Constructors
| ChannelMembershipSummary' | |
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.
channelMembershipSummary_member :: Lens' ChannelMembershipSummary (Maybe Identity) Source #
A member's summary data.
ChannelMessage
data ChannelMessage Source #
The details of a message in a channel.
See: newChannelMessage smart constructor.
Constructors
| ChannelMessage' | |
Fields
| |
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.
channelMessage_channelArn :: Lens' ChannelMessage (Maybe Text) Source #
The ARN of the channel.
channelMessage_content :: Lens' ChannelMessage (Maybe Text) Source #
The message content.
channelMessage_createdTimestamp :: Lens' ChannelMessage (Maybe UTCTime) Source #
The time at which the message was created.
channelMessage_lastEditedTimestamp :: Lens' ChannelMessage (Maybe UTCTime) Source #
The time at which a message was edited.
channelMessage_lastUpdatedTimestamp :: Lens' ChannelMessage (Maybe UTCTime) Source #
The time at which a message was updated.
channelMessage_messageAttributes :: Lens' ChannelMessage (Maybe (HashMap Text MessageAttributeValue)) Source #
The attributes for the message, used for message filtering along with a
FilterRule defined in the PushNotificationPreferences.
channelMessage_messageId :: Lens' ChannelMessage (Maybe Text) Source #
The ID of a message.
channelMessage_metadata :: Lens' ChannelMessage (Maybe Text) Source #
The message metadata.
channelMessage_persistence :: Lens' ChannelMessage (Maybe ChannelMessagePersistenceType) Source #
The persistence setting for a channel message.
channelMessage_redacted :: Lens' ChannelMessage (Maybe Bool) Source #
Hides the content of a message.
channelMessage_sender :: Lens' ChannelMessage (Maybe Identity) Source #
The message sender.
channelMessage_status :: Lens' ChannelMessage (Maybe ChannelMessageStatusStructure) Source #
The status of the channel message.
channelMessage_subChannelId :: Lens' ChannelMessage (Maybe Text) Source #
The ID of the SubChannel.
channelMessage_type :: Lens' ChannelMessage (Maybe ChannelMessageType) Source #
The message type.
ChannelMessageCallback
data ChannelMessageCallback Source #
Stores information about a callback.
See: newChannelMessageCallback smart constructor.
Constructors
| ChannelMessageCallback' | |
Fields
| |
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.
channelMessageCallback_content :: Lens' ChannelMessageCallback (Maybe Text) Source #
The message content.
channelMessageCallback_messageAttributes :: Lens' ChannelMessageCallback (Maybe (HashMap Text MessageAttributeValue)) Source #
The attributes for the message, used for message filtering along with a
FilterRule defined in the PushNotificationPreferences.
channelMessageCallback_metadata :: Lens' ChannelMessageCallback (Maybe Text) Source #
The message metadata.
channelMessageCallback_pushNotification :: Lens' ChannelMessageCallback (Maybe PushNotificationConfiguration) Source #
The push notification configuration of the message.
channelMessageCallback_subChannelId :: Lens' ChannelMessageCallback (Maybe Text) Source #
The ID of the SubChannel.
channelMessageCallback_messageId :: Lens' ChannelMessageCallback Text Source #
The message ID.
ChannelMessageStatusStructure
data ChannelMessageStatusStructure Source #
Stores information about a message status.
See: newChannelMessageStatusStructure smart constructor.
Constructors
| ChannelMessageStatusStructure' | |
Instances
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.
channelMessageStatusStructure_detail :: Lens' ChannelMessageStatusStructure (Maybe Text) Source #
Contains more details about the messasge status.
channelMessageStatusStructure_value :: Lens' ChannelMessageStatusStructure (Maybe ChannelMessageStatus) Source #
The message status value.
ChannelMessageSummary
data ChannelMessageSummary Source #
Summary of the messages in a Channel.
See: newChannelMessageSummary smart constructor.
Constructors
| ChannelMessageSummary' | |
Fields
| |
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.
channelMessageSummary_content :: Lens' ChannelMessageSummary (Maybe Text) Source #
The content of the message.
channelMessageSummary_createdTimestamp :: Lens' ChannelMessageSummary (Maybe UTCTime) Source #
The time at which the message summary was created.
channelMessageSummary_lastEditedTimestamp :: Lens' ChannelMessageSummary (Maybe UTCTime) Source #
The time at which a message was last edited.
channelMessageSummary_lastUpdatedTimestamp :: Lens' ChannelMessageSummary (Maybe UTCTime) Source #
The time at which a message was last updated.
channelMessageSummary_messageAttributes :: Lens' ChannelMessageSummary (Maybe (HashMap Text MessageAttributeValue)) Source #
The message attribues listed in a the summary of a channel message.
channelMessageSummary_messageId :: Lens' ChannelMessageSummary (Maybe Text) Source #
The ID of the message.
channelMessageSummary_metadata :: Lens' ChannelMessageSummary (Maybe Text) Source #
The metadata of the message.
channelMessageSummary_redacted :: Lens' ChannelMessageSummary (Maybe Bool) Source #
Indicates whether a message was redacted.
channelMessageSummary_sender :: Lens' ChannelMessageSummary (Maybe Identity) Source #
The message sender.
channelMessageSummary_status :: Lens' ChannelMessageSummary (Maybe ChannelMessageStatusStructure) Source #
The message status. The status value is SENT for messages sent to a
channel without a channel flow. For channels associated with channel
flow, the value determines the processing stage.
channelMessageSummary_type :: Lens' ChannelMessageSummary (Maybe ChannelMessageType) Source #
The type of message.
ChannelModeratedByAppInstanceUserSummary
data ChannelModeratedByAppInstanceUserSummary Source #
Summary of the details of a moderated channel.
See: newChannelModeratedByAppInstanceUserSummary smart constructor.
Constructors
| ChannelModeratedByAppInstanceUserSummary' | |
Fields
| |
Instances
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.
channelModeratedByAppInstanceUserSummary_channelSummary :: Lens' ChannelModeratedByAppInstanceUserSummary (Maybe ChannelSummary) Source #
Summary of the details of a Channel.
ChannelModerator
data ChannelModerator Source #
The details of a channel moderator.
See: newChannelModerator smart constructor.
Constructors
| ChannelModerator' | |
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.
channelModerator_channelArn :: Lens' ChannelModerator (Maybe Text) Source #
The ARN of the moderator's channel.
channelModerator_createdBy :: Lens' ChannelModerator (Maybe Identity) Source #
The AppInstanceUser who created the moderator.
channelModerator_createdTimestamp :: Lens' ChannelModerator (Maybe UTCTime) Source #
The time at which the moderator was created.
channelModerator_moderator :: Lens' ChannelModerator (Maybe Identity) Source #
The moderator's data.
ChannelModeratorSummary
data ChannelModeratorSummary Source #
Summary of the details of a ChannelModerator.
See: newChannelModeratorSummary smart constructor.
Constructors
| ChannelModeratorSummary' | |
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.
channelModeratorSummary_moderator :: Lens' ChannelModeratorSummary (Maybe Identity) Source #
The data for a moderator.
ChannelSummary
data ChannelSummary Source #
Summary of the details of a Channel.
See: newChannelSummary smart constructor.
Constructors
| ChannelSummary' | |
Fields
| |
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.
channelSummary_channelArn :: Lens' ChannelSummary (Maybe Text) Source #
The ARN of the channel.
channelSummary_lastMessageTimestamp :: Lens' ChannelSummary (Maybe UTCTime) Source #
The time at which the last persistent message in a channel was sent.
channelSummary_metadata :: Lens' ChannelSummary (Maybe Text) Source #
The metadata of the channel.
channelSummary_mode :: Lens' ChannelSummary (Maybe ChannelMode) Source #
The mode of the channel.
channelSummary_name :: Lens' ChannelSummary (Maybe Text) Source #
The name of the channel.
channelSummary_privacy :: Lens' ChannelSummary (Maybe ChannelPrivacy) Source #
The privacy setting of the channel.
ElasticChannelConfiguration
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.
Constructors
| ElasticChannelConfiguration' | |
Fields
| |
Instances
newElasticChannelConfiguration Source #
Arguments
| :: 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.
elasticChannelConfiguration_maximumSubChannels :: Lens' ElasticChannelConfiguration Natural Source #
The maximum number of SubChannels that you want to allow in the elastic channel.
elasticChannelConfiguration_targetMembershipsPerSubChannel :: Lens' ElasticChannelConfiguration Natural Source #
The maximum number of members allowed in a SubChannel.
elasticChannelConfiguration_minimumMembershipPercentage :: Lens' ElasticChannelConfiguration Natural Source #
The minimum allowed percentage of TargetMembershipsPerSubChannel users. Ceil of the calculated value is used in balancing members among SubChannels of the elastic channel.
Identity
The details of a user.
See: newIdentity smart constructor.
Constructors
| Identity' | |
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.
Constructors
| LambdaConfiguration' | |
Fields
| |
Instances
newLambdaConfiguration Source #
Arguments
| :: Text | |
| -> InvocationType | |
| -> LambdaConfiguration |
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.
lambdaConfiguration_resourceArn :: Lens' LambdaConfiguration Text Source #
The ARN of the Lambda message processing function.
lambdaConfiguration_invocationType :: Lens' LambdaConfiguration InvocationType Source #
Controls how the Lambda function is invoked.
MessageAttributeValue
data MessageAttributeValue Source #
A list of message attribute values.
See: newMessageAttributeValue smart constructor.
Constructors
| MessageAttributeValue' | |
Fields
| |
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.
messageAttributeValue_stringValues :: Lens' MessageAttributeValue (Maybe [Text]) Source #
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.
Constructors
| MessagingSessionEndpoint' | |
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.
messagingSessionEndpoint_url :: Lens' MessagingSessionEndpoint (Maybe Text) Source #
The endpoint to which you establish a websocket connection.
Processor
The information about a processor in a channel flow.
See: newProcessor smart constructor.
Constructors
| Processor' | |
Fields
| |
Instances
Arguments
| :: 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.
processor_configuration :: Lens' Processor ProcessorConfiguration Source #
The information about the type of processor and its identifier.
processor_executionOrder :: Lens' Processor Natural Source #
The sequence in which processors run. If you have multiple processors in a channel flow, message processing goes through each processor in the sequence. The value determines the sequence. At this point, we support only 1 processor within a flow.
processor_fallbackAction :: Lens' Processor FallbackAction Source #
Determines whether to continue with message processing or stop it in
cases where communication with a processor fails. If a processor has a
fallback action of ABORT and communication with it fails, the
processor sets the message status to FAILED and does not send the
message to any recipients. Note that if the last processor in the
channel flow sequence has a fallback action of CONTINUE and
communication with the processor fails, then the message is considered
processed and sent to recipients of the channel.
ProcessorConfiguration
data ProcessorConfiguration Source #
A processor's metadata.
See: newProcessorConfiguration smart constructor.
Constructors
| ProcessorConfiguration' | |
Fields
| |
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.
processorConfiguration_lambda :: Lens' ProcessorConfiguration LambdaConfiguration Source #
Indicates that the processor is of type Lambda.
PushNotificationConfiguration
data PushNotificationConfiguration Source #
The push notification configuration of the message.
See: newPushNotificationConfiguration smart constructor.
Constructors
| PushNotificationConfiguration' | |
Fields
| |
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.
pushNotificationConfiguration_body :: Lens' PushNotificationConfiguration (Maybe Text) Source #
The body of the push notification.
pushNotificationConfiguration_title :: Lens' PushNotificationConfiguration (Maybe Text) Source #
The title of the push notification.
pushNotificationConfiguration_type :: Lens' PushNotificationConfiguration (Maybe PushNotificationType) Source #
Enum value that indicates the type of the push notification for a
message. DEFAULT: Normal mobile push notification. VOIP: VOIP mobile
push notification.
PushNotificationPreferences
data PushNotificationPreferences Source #
The channel membership preferences for push notification.
See: newPushNotificationPreferences smart constructor.
Constructors
| PushNotificationPreferences' | |
Fields
| |
Instances
newPushNotificationPreferences Source #
Arguments
| :: AllowNotifications | |
| -> PushNotificationPreferences |
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.
pushNotificationPreferences_filterRule :: Lens' PushNotificationPreferences (Maybe Text) Source #
The simple JSON object used to send a subset of a push notification to the requested member.
pushNotificationPreferences_allowNotifications :: Lens' PushNotificationPreferences AllowNotifications Source #
Enum value that indicates which push notifications to send to the
requested member of a channel. ALL sends all push notifications,
NONE sends no push notifications, FILTERED sends only filtered push
notifications.
SearchField
data SearchField Source #
A Field of the channel that you want to search.
See: newSearchField smart constructor.
Constructors
| SearchField' | |
Fields
| |
Instances
Arguments
| :: SearchFieldKey | |
| -> NonEmpty Text | |
| -> SearchFieldOperator | |
| -> SearchField |
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.
searchField_key :: Lens' SearchField SearchFieldKey Source #
An enum value that indicates the key to search the channel on.
MEMBERS allows you to search channels based on memberships. You can
use it with the EQUALS operator to get channels whose memberships are
equal to the specified values, and with the INCLUDES operator to get
channels whose memberships include the specified values.
searchField_values :: Lens' SearchField (NonEmpty Text) Source #
The values that you want to search for, a list of strings. The values
must be AppInstanceUserArns specified as a list of strings.
This operation isn't supported for AppInstanceUsers with large number
of memberships.
searchField_operator :: Lens' SearchField SearchFieldOperator Source #
The operator used to compare field values, currently EQUALS or
INCLUDES. Use the EQUALS operator to find channels whose memberships
equal the specified values. Use the INCLUDES operator to find channels
whose memberships include the specified values.
SubChannelSummary
data SubChannelSummary Source #
Summary of the sub-channels associated with the elastic channel.
See: newSubChannelSummary smart constructor.
Constructors
| SubChannelSummary' | |
Fields
| |
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.
subChannelSummary_membershipCount :: Lens' SubChannelSummary (Maybe Int) Source #
The number of members in a SubChannel.
subChannelSummary_subChannelId :: Lens' SubChannelSummary (Maybe Text) Source #
The unique ID of a SubChannel.
Tag
A tag object containing a key-value pair.
See: newTag smart constructor.
Constructors
| Tag' | |
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.