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
- AllowMessages
- AppInstanceUserEndpointType
- EndpointStatus
- EndpointStatusReason
- AppInstance
- AppInstanceAdmin
- AppInstanceAdminSummary
- AppInstanceRetentionSettings
- AppInstanceSummary
- AppInstanceUser
- AppInstanceUserEndpoint
- AppInstanceUserEndpointSummary
- AppInstanceUserSummary
- ChannelRetentionSettings
- EndpointAttributes
- EndpointState
- Identity
- Tag
Synopsis
- defaultService :: Service
- _BadRequestException :: AsError a => Fold a ServiceError
- _ConflictException :: AsError a => Fold a ServiceError
- _ForbiddenException :: 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 AllowMessages where
- AllowMessages' { }
- pattern AllowMessages_ALL :: AllowMessages
- pattern AllowMessages_NONE :: AllowMessages
- newtype AppInstanceUserEndpointType where
- newtype EndpointStatus where
- EndpointStatus' { }
- pattern EndpointStatus_ACTIVE :: EndpointStatus
- pattern EndpointStatus_INACTIVE :: EndpointStatus
- newtype EndpointStatusReason where
- data AppInstance = AppInstance' {}
- newAppInstance :: AppInstance
- appInstance_appInstanceArn :: Lens' AppInstance (Maybe Text)
- appInstance_createdTimestamp :: Lens' AppInstance (Maybe UTCTime)
- appInstance_lastUpdatedTimestamp :: Lens' AppInstance (Maybe UTCTime)
- appInstance_metadata :: Lens' AppInstance (Maybe Text)
- appInstance_name :: Lens' AppInstance (Maybe Text)
- data AppInstanceAdmin = AppInstanceAdmin' {}
- newAppInstanceAdmin :: AppInstanceAdmin
- appInstanceAdmin_admin :: Lens' AppInstanceAdmin (Maybe Identity)
- appInstanceAdmin_appInstanceArn :: Lens' AppInstanceAdmin (Maybe Text)
- appInstanceAdmin_createdTimestamp :: Lens' AppInstanceAdmin (Maybe UTCTime)
- data AppInstanceAdminSummary = AppInstanceAdminSummary' {}
- newAppInstanceAdminSummary :: AppInstanceAdminSummary
- appInstanceAdminSummary_admin :: Lens' AppInstanceAdminSummary (Maybe Identity)
- data AppInstanceRetentionSettings = AppInstanceRetentionSettings' {}
- newAppInstanceRetentionSettings :: AppInstanceRetentionSettings
- appInstanceRetentionSettings_channelRetentionSettings :: Lens' AppInstanceRetentionSettings (Maybe ChannelRetentionSettings)
- data AppInstanceSummary = AppInstanceSummary' {}
- newAppInstanceSummary :: AppInstanceSummary
- appInstanceSummary_appInstanceArn :: Lens' AppInstanceSummary (Maybe Text)
- appInstanceSummary_metadata :: Lens' AppInstanceSummary (Maybe Text)
- appInstanceSummary_name :: Lens' AppInstanceSummary (Maybe Text)
- data AppInstanceUser = AppInstanceUser' {}
- newAppInstanceUser :: AppInstanceUser
- appInstanceUser_appInstanceUserArn :: Lens' AppInstanceUser (Maybe Text)
- appInstanceUser_createdTimestamp :: Lens' AppInstanceUser (Maybe UTCTime)
- appInstanceUser_lastUpdatedTimestamp :: Lens' AppInstanceUser (Maybe UTCTime)
- appInstanceUser_metadata :: Lens' AppInstanceUser (Maybe Text)
- appInstanceUser_name :: Lens' AppInstanceUser (Maybe Text)
- data AppInstanceUserEndpoint = AppInstanceUserEndpoint' {
- allowMessages :: Maybe AllowMessages
- appInstanceUserArn :: Maybe (Sensitive Text)
- createdTimestamp :: Maybe POSIX
- endpointAttributes :: Maybe EndpointAttributes
- endpointId :: Maybe (Sensitive Text)
- endpointState :: Maybe EndpointState
- lastUpdatedTimestamp :: Maybe POSIX
- name :: Maybe (Sensitive Text)
- resourceArn :: Maybe (Sensitive Text)
- type' :: Maybe AppInstanceUserEndpointType
- newAppInstanceUserEndpoint :: AppInstanceUserEndpoint
- appInstanceUserEndpoint_allowMessages :: Lens' AppInstanceUserEndpoint (Maybe AllowMessages)
- appInstanceUserEndpoint_appInstanceUserArn :: Lens' AppInstanceUserEndpoint (Maybe Text)
- appInstanceUserEndpoint_createdTimestamp :: Lens' AppInstanceUserEndpoint (Maybe UTCTime)
- appInstanceUserEndpoint_endpointAttributes :: Lens' AppInstanceUserEndpoint (Maybe EndpointAttributes)
- appInstanceUserEndpoint_endpointId :: Lens' AppInstanceUserEndpoint (Maybe Text)
- appInstanceUserEndpoint_endpointState :: Lens' AppInstanceUserEndpoint (Maybe EndpointState)
- appInstanceUserEndpoint_lastUpdatedTimestamp :: Lens' AppInstanceUserEndpoint (Maybe UTCTime)
- appInstanceUserEndpoint_name :: Lens' AppInstanceUserEndpoint (Maybe Text)
- appInstanceUserEndpoint_resourceArn :: Lens' AppInstanceUserEndpoint (Maybe Text)
- appInstanceUserEndpoint_type :: Lens' AppInstanceUserEndpoint (Maybe AppInstanceUserEndpointType)
- data AppInstanceUserEndpointSummary = AppInstanceUserEndpointSummary' {}
- newAppInstanceUserEndpointSummary :: AppInstanceUserEndpointSummary
- appInstanceUserEndpointSummary_allowMessages :: Lens' AppInstanceUserEndpointSummary (Maybe AllowMessages)
- appInstanceUserEndpointSummary_appInstanceUserArn :: Lens' AppInstanceUserEndpointSummary (Maybe Text)
- appInstanceUserEndpointSummary_endpointId :: Lens' AppInstanceUserEndpointSummary (Maybe Text)
- appInstanceUserEndpointSummary_endpointState :: Lens' AppInstanceUserEndpointSummary (Maybe EndpointState)
- appInstanceUserEndpointSummary_name :: Lens' AppInstanceUserEndpointSummary (Maybe Text)
- appInstanceUserEndpointSummary_type :: Lens' AppInstanceUserEndpointSummary (Maybe AppInstanceUserEndpointType)
- data AppInstanceUserSummary = AppInstanceUserSummary' {}
- newAppInstanceUserSummary :: AppInstanceUserSummary
- appInstanceUserSummary_appInstanceUserArn :: Lens' AppInstanceUserSummary (Maybe Text)
- appInstanceUserSummary_metadata :: Lens' AppInstanceUserSummary (Maybe Text)
- appInstanceUserSummary_name :: Lens' AppInstanceUserSummary (Maybe Text)
- data ChannelRetentionSettings = ChannelRetentionSettings' {}
- newChannelRetentionSettings :: ChannelRetentionSettings
- channelRetentionSettings_retentionDays :: Lens' ChannelRetentionSettings (Maybe Natural)
- data EndpointAttributes = EndpointAttributes' {}
- newEndpointAttributes :: Text -> EndpointAttributes
- endpointAttributes_voipDeviceToken :: Lens' EndpointAttributes (Maybe Text)
- endpointAttributes_deviceToken :: Lens' EndpointAttributes Text
- data EndpointState = EndpointState' {}
- newEndpointState :: EndpointStatus -> EndpointState
- endpointState_statusReason :: Lens' EndpointState (Maybe EndpointStatusReason)
- endpointState_status :: Lens' EndpointState EndpointStatus
- data Identity = Identity' {}
- newIdentity :: Identity
- identity_arn :: Lens' Identity (Maybe Text)
- identity_name :: Lens' Identity (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-04-20
of the Amazon Chime SDK Identity 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.
_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.
AllowMessages
newtype AllowMessages Source #
pattern AllowMessages_ALL :: AllowMessages | |
pattern AllowMessages_NONE :: AllowMessages |
Instances
AppInstanceUserEndpointType
newtype AppInstanceUserEndpointType Source #
Instances
EndpointStatus
newtype EndpointStatus Source #
pattern EndpointStatus_ACTIVE :: EndpointStatus | |
pattern EndpointStatus_INACTIVE :: EndpointStatus |
Instances
EndpointStatusReason
newtype EndpointStatusReason Source #
pattern EndpointStatusReason_INVALID_DEVICE_TOKEN :: EndpointStatusReason | |
pattern EndpointStatusReason_INVALID_PINPOINT_ARN :: EndpointStatusReason |
Instances
AppInstance
data AppInstance Source #
The details of an AppInstance
, an instance of an Amazon Chime SDK
messaging application.
See: newAppInstance
smart constructor.
AppInstance' | |
|
Instances
newAppInstance :: AppInstance Source #
Create a value of AppInstance
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:appInstanceArn:AppInstance'
, appInstance_appInstanceArn
- The ARN of the messaging instance.
$sel:createdTimestamp:AppInstance'
, appInstance_createdTimestamp
- The time at which an AppInstance
was created. In epoch milliseconds.
$sel:lastUpdatedTimestamp:AppInstance'
, appInstance_lastUpdatedTimestamp
- The time an AppInstance
was last updated. In epoch milliseconds.
$sel:metadata:AppInstance'
, appInstance_metadata
- The metadata of an AppInstance
.
$sel:name:AppInstance'
, appInstance_name
- The name of an AppInstance
.
appInstance_appInstanceArn :: Lens' AppInstance (Maybe Text) Source #
The ARN of the messaging instance.
appInstance_createdTimestamp :: Lens' AppInstance (Maybe UTCTime) Source #
The time at which an AppInstance
was created. In epoch milliseconds.
appInstance_lastUpdatedTimestamp :: Lens' AppInstance (Maybe UTCTime) Source #
The time an AppInstance
was last updated. In epoch milliseconds.
appInstance_metadata :: Lens' AppInstance (Maybe Text) Source #
The metadata of an AppInstance
.
appInstance_name :: Lens' AppInstance (Maybe Text) Source #
The name of an AppInstance
.
AppInstanceAdmin
data AppInstanceAdmin Source #
The details of an AppInstanceAdmin
.
See: newAppInstanceAdmin
smart constructor.
AppInstanceAdmin' | |
|
Instances
newAppInstanceAdmin :: AppInstanceAdmin Source #
Create a value of AppInstanceAdmin
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:admin:AppInstanceAdmin'
, appInstanceAdmin_admin
- The AppInstanceAdmin
data.
$sel:appInstanceArn:AppInstanceAdmin'
, appInstanceAdmin_appInstanceArn
- The ARN of the AppInstance
for which the user is an administrator.
$sel:createdTimestamp:AppInstanceAdmin'
, appInstanceAdmin_createdTimestamp
- The time at which an administrator was created.
appInstanceAdmin_admin :: Lens' AppInstanceAdmin (Maybe Identity) Source #
The AppInstanceAdmin
data.
appInstanceAdmin_appInstanceArn :: Lens' AppInstanceAdmin (Maybe Text) Source #
The ARN of the AppInstance
for which the user is an administrator.
appInstanceAdmin_createdTimestamp :: Lens' AppInstanceAdmin (Maybe UTCTime) Source #
The time at which an administrator was created.
AppInstanceAdminSummary
data AppInstanceAdminSummary Source #
Summary of the details of an AppInstanceAdmin
.
See: newAppInstanceAdminSummary
smart constructor.
Instances
newAppInstanceAdminSummary :: AppInstanceAdminSummary Source #
Create a value of AppInstanceAdminSummary
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:admin:AppInstanceAdminSummary'
, appInstanceAdminSummary_admin
- The details of the AppInstanceAdmin
.
appInstanceAdminSummary_admin :: Lens' AppInstanceAdminSummary (Maybe Identity) Source #
The details of the AppInstanceAdmin
.
AppInstanceRetentionSettings
data AppInstanceRetentionSettings Source #
The details of the data-retention settings for an AppInstance
.
See: newAppInstanceRetentionSettings
smart constructor.
AppInstanceRetentionSettings' | |
|
Instances
newAppInstanceRetentionSettings :: AppInstanceRetentionSettings Source #
Create a value of AppInstanceRetentionSettings
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:channelRetentionSettings:AppInstanceRetentionSettings'
, appInstanceRetentionSettings_channelRetentionSettings
- The length of time in days to retain the messages in a channel.
appInstanceRetentionSettings_channelRetentionSettings :: Lens' AppInstanceRetentionSettings (Maybe ChannelRetentionSettings) Source #
The length of time in days to retain the messages in a channel.
AppInstanceSummary
data AppInstanceSummary Source #
Summary of the data for an AppInstance
.
See: newAppInstanceSummary
smart constructor.
Instances
newAppInstanceSummary :: AppInstanceSummary Source #
Create a value of AppInstanceSummary
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:appInstanceArn:AppInstanceSummary'
, appInstanceSummary_appInstanceArn
- The AppInstance
ARN.
$sel:metadata:AppInstanceSummary'
, appInstanceSummary_metadata
- The metadata of the AppInstance
.
$sel:name:AppInstanceSummary'
, appInstanceSummary_name
- The name of the AppInstance
.
appInstanceSummary_appInstanceArn :: Lens' AppInstanceSummary (Maybe Text) Source #
The AppInstance
ARN.
appInstanceSummary_metadata :: Lens' AppInstanceSummary (Maybe Text) Source #
The metadata of the AppInstance
.
appInstanceSummary_name :: Lens' AppInstanceSummary (Maybe Text) Source #
The name of the AppInstance
.
AppInstanceUser
data AppInstanceUser Source #
The details of an AppInstanceUser
.
See: newAppInstanceUser
smart constructor.
AppInstanceUser' | |
|
Instances
newAppInstanceUser :: AppInstanceUser Source #
Create a value of AppInstanceUser
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:AppInstanceUser'
, appInstanceUser_appInstanceUserArn
- The ARN of the AppInstanceUser
.
$sel:createdTimestamp:AppInstanceUser'
, appInstanceUser_createdTimestamp
- The time at which the AppInstanceUser
was created.
$sel:lastUpdatedTimestamp:AppInstanceUser'
, appInstanceUser_lastUpdatedTimestamp
- The time at which the AppInstanceUser
was last updated.
$sel:metadata:AppInstanceUser'
, appInstanceUser_metadata
- The metadata of the AppInstanceUser
.
$sel:name:AppInstanceUser'
, appInstanceUser_name
- The name of the AppInstanceUser
.
appInstanceUser_appInstanceUserArn :: Lens' AppInstanceUser (Maybe Text) Source #
The ARN of the AppInstanceUser
.
appInstanceUser_createdTimestamp :: Lens' AppInstanceUser (Maybe UTCTime) Source #
The time at which the AppInstanceUser
was created.
appInstanceUser_lastUpdatedTimestamp :: Lens' AppInstanceUser (Maybe UTCTime) Source #
The time at which the AppInstanceUser
was last updated.
appInstanceUser_metadata :: Lens' AppInstanceUser (Maybe Text) Source #
The metadata of the AppInstanceUser
.
appInstanceUser_name :: Lens' AppInstanceUser (Maybe Text) Source #
The name of the AppInstanceUser
.
AppInstanceUserEndpoint
data AppInstanceUserEndpoint Source #
An endpoint under an Amazon Chime AppInstanceUser
that receives
messages for a user. For push notifications, the endpoint is a mobile
device used to receive mobile push notifications for a user.
See: newAppInstanceUserEndpoint
smart constructor.
AppInstanceUserEndpoint' | |
|
Instances
newAppInstanceUserEndpoint :: AppInstanceUserEndpoint Source #
Create a value of AppInstanceUserEndpoint
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:allowMessages:AppInstanceUserEndpoint'
, appInstanceUserEndpoint_allowMessages
- Boolean that controls whether the AppInstanceUserEndpoint
is opted in
to receive messages. ALL
indicates the endpoint will receive all
messages. NONE
indicates the endpoint will receive no messages.
$sel:appInstanceUserArn:AppInstanceUserEndpoint'
, appInstanceUserEndpoint_appInstanceUserArn
- The ARN of the AppInstanceUser
.
$sel:createdTimestamp:AppInstanceUserEndpoint'
, appInstanceUserEndpoint_createdTimestamp
- The time at which an AppInstanceUserEndpoint
was created.
$sel:endpointAttributes:AppInstanceUserEndpoint'
, appInstanceUserEndpoint_endpointAttributes
- The attributes of an Endpoint
.
$sel:endpointId:AppInstanceUserEndpoint'
, appInstanceUserEndpoint_endpointId
- The unique identifier of the AppInstanceUserEndpoint
.
$sel:endpointState:AppInstanceUserEndpoint'
, appInstanceUserEndpoint_endpointState
- A read-only field that represents the state of an
AppInstanceUserEndpoint
. Supported values:
ACTIVE
: TheAppInstanceUserEndpoint
is active and able to receive messages. WhenACTIVE
, theEndpointStatusReason
remains empty.INACTIVE
: TheAppInstanceUserEndpoint
is inactive and can't receive message. WhenINACTIVE
, the corresponding reason will be conveyed throughEndpointStatusReason
.INVALID_DEVICE_TOKEN
indicates that anAppInstanceUserEndpoint
isINACTIVE
due to invalid device tokenINVALID_PINPOINT_ARN
indicates that anAppInstanceUserEndpoint
isINACTIVE
due to an invalid pinpoint ARN that was input through theResourceArn
field.
$sel:lastUpdatedTimestamp:AppInstanceUserEndpoint'
, appInstanceUserEndpoint_lastUpdatedTimestamp
- The time at which an AppInstanceUserEndpoint
was last updated.
$sel:name:AppInstanceUserEndpoint'
, appInstanceUserEndpoint_name
- The name of the AppInstanceUserEndpoint
.
$sel:resourceArn:AppInstanceUserEndpoint'
, appInstanceUserEndpoint_resourceArn
- The ARN of the resource to which the endpoint belongs.
$sel:type':AppInstanceUserEndpoint'
, appInstanceUserEndpoint_type
- The type of the AppInstanceUserEndpoint
.
appInstanceUserEndpoint_allowMessages :: Lens' AppInstanceUserEndpoint (Maybe AllowMessages) Source #
Boolean that controls whether the AppInstanceUserEndpoint
is opted in
to receive messages. ALL
indicates the endpoint will receive all
messages. NONE
indicates the endpoint will receive no messages.
appInstanceUserEndpoint_appInstanceUserArn :: Lens' AppInstanceUserEndpoint (Maybe Text) Source #
The ARN of the AppInstanceUser
.
appInstanceUserEndpoint_createdTimestamp :: Lens' AppInstanceUserEndpoint (Maybe UTCTime) Source #
The time at which an AppInstanceUserEndpoint
was created.
appInstanceUserEndpoint_endpointAttributes :: Lens' AppInstanceUserEndpoint (Maybe EndpointAttributes) Source #
The attributes of an Endpoint
.
appInstanceUserEndpoint_endpointId :: Lens' AppInstanceUserEndpoint (Maybe Text) Source #
The unique identifier of the AppInstanceUserEndpoint
.
appInstanceUserEndpoint_endpointState :: Lens' AppInstanceUserEndpoint (Maybe EndpointState) Source #
A read-only field that represents the state of an
AppInstanceUserEndpoint
. Supported values:
ACTIVE
: TheAppInstanceUserEndpoint
is active and able to receive messages. WhenACTIVE
, theEndpointStatusReason
remains empty.INACTIVE
: TheAppInstanceUserEndpoint
is inactive and can't receive message. WhenINACTIVE
, the corresponding reason will be conveyed throughEndpointStatusReason
.INVALID_DEVICE_TOKEN
indicates that anAppInstanceUserEndpoint
isINACTIVE
due to invalid device tokenINVALID_PINPOINT_ARN
indicates that anAppInstanceUserEndpoint
isINACTIVE
due to an invalid pinpoint ARN that was input through theResourceArn
field.
appInstanceUserEndpoint_lastUpdatedTimestamp :: Lens' AppInstanceUserEndpoint (Maybe UTCTime) Source #
The time at which an AppInstanceUserEndpoint
was last updated.
appInstanceUserEndpoint_name :: Lens' AppInstanceUserEndpoint (Maybe Text) Source #
The name of the AppInstanceUserEndpoint
.
appInstanceUserEndpoint_resourceArn :: Lens' AppInstanceUserEndpoint (Maybe Text) Source #
The ARN of the resource to which the endpoint belongs.
appInstanceUserEndpoint_type :: Lens' AppInstanceUserEndpoint (Maybe AppInstanceUserEndpointType) Source #
The type of the AppInstanceUserEndpoint
.
AppInstanceUserEndpointSummary
data AppInstanceUserEndpointSummary Source #
Summary of the details of an AppInstanceUserEndpoint
.
See: newAppInstanceUserEndpointSummary
smart constructor.
AppInstanceUserEndpointSummary' | |
|
Instances
newAppInstanceUserEndpointSummary :: AppInstanceUserEndpointSummary Source #
Create a value of AppInstanceUserEndpointSummary
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:allowMessages:AppInstanceUserEndpointSummary'
, appInstanceUserEndpointSummary_allowMessages
- BBoolean that controls whether the AppInstanceUserEndpoint
is opted in
to receive messages. ALL
indicates the endpoint will receive all
messages. NONE
indicates the endpoint will receive no messages.
$sel:appInstanceUserArn:AppInstanceUserEndpointSummary'
, appInstanceUserEndpointSummary_appInstanceUserArn
- The ARN of the AppInstanceUser
.
$sel:endpointId:AppInstanceUserEndpointSummary'
, appInstanceUserEndpointSummary_endpointId
- The unique identifier of the AppInstanceUserEndpoint
.
$sel:endpointState:AppInstanceUserEndpointSummary'
, appInstanceUserEndpointSummary_endpointState
- A read-only field that represent the state of an
AppInstanceUserEndpoint
.
$sel:name:AppInstanceUserEndpointSummary'
, appInstanceUserEndpointSummary_name
- The name of the AppInstanceUserEndpoint
.
$sel:type':AppInstanceUserEndpointSummary'
, appInstanceUserEndpointSummary_type
- The type of the AppInstanceUserEndpoint
.
appInstanceUserEndpointSummary_allowMessages :: Lens' AppInstanceUserEndpointSummary (Maybe AllowMessages) Source #
BBoolean that controls whether the AppInstanceUserEndpoint
is opted in
to receive messages. ALL
indicates the endpoint will receive all
messages. NONE
indicates the endpoint will receive no messages.
appInstanceUserEndpointSummary_appInstanceUserArn :: Lens' AppInstanceUserEndpointSummary (Maybe Text) Source #
The ARN of the AppInstanceUser
.
appInstanceUserEndpointSummary_endpointId :: Lens' AppInstanceUserEndpointSummary (Maybe Text) Source #
The unique identifier of the AppInstanceUserEndpoint
.
appInstanceUserEndpointSummary_endpointState :: Lens' AppInstanceUserEndpointSummary (Maybe EndpointState) Source #
A read-only field that represent the state of an
AppInstanceUserEndpoint
.
appInstanceUserEndpointSummary_name :: Lens' AppInstanceUserEndpointSummary (Maybe Text) Source #
The name of the AppInstanceUserEndpoint
.
appInstanceUserEndpointSummary_type :: Lens' AppInstanceUserEndpointSummary (Maybe AppInstanceUserEndpointType) Source #
The type of the AppInstanceUserEndpoint
.
AppInstanceUserSummary
data AppInstanceUserSummary Source #
Summary of the details of an AppInstanceUser
.
See: newAppInstanceUserSummary
smart constructor.
Instances
newAppInstanceUserSummary :: AppInstanceUserSummary Source #
Create a value of AppInstanceUserSummary
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:AppInstanceUserSummary'
, appInstanceUserSummary_appInstanceUserArn
- The ARN of the AppInstanceUser
.
$sel:metadata:AppInstanceUserSummary'
, appInstanceUserSummary_metadata
- The metadata of the AppInstanceUser
.
$sel:name:AppInstanceUserSummary'
, appInstanceUserSummary_name
- The name of an AppInstanceUser
.
appInstanceUserSummary_appInstanceUserArn :: Lens' AppInstanceUserSummary (Maybe Text) Source #
The ARN of the AppInstanceUser
.
appInstanceUserSummary_metadata :: Lens' AppInstanceUserSummary (Maybe Text) Source #
The metadata of the AppInstanceUser
.
appInstanceUserSummary_name :: Lens' AppInstanceUserSummary (Maybe Text) Source #
The name of an AppInstanceUser
.
ChannelRetentionSettings
data ChannelRetentionSettings Source #
The details of the retention settings for a channel.
See: newChannelRetentionSettings
smart constructor.
ChannelRetentionSettings' | |
|
Instances
newChannelRetentionSettings :: ChannelRetentionSettings Source #
Create a value of ChannelRetentionSettings
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:retentionDays:ChannelRetentionSettings'
, channelRetentionSettings_retentionDays
- The time in days to retain the messages in a channel.
channelRetentionSettings_retentionDays :: Lens' ChannelRetentionSettings (Maybe Natural) Source #
The time in days to retain the messages in a channel.
EndpointAttributes
data EndpointAttributes Source #
The attributes of an Endpoint
.
See: newEndpointAttributes
smart constructor.
EndpointAttributes' | |
|
Instances
newEndpointAttributes Source #
Create a value of EndpointAttributes
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:voipDeviceToken:EndpointAttributes'
, endpointAttributes_voipDeviceToken
- The VOIP device token for the APNS and APNS_SANDBOX endpoint types.
$sel:deviceToken:EndpointAttributes'
, endpointAttributes_deviceToken
- The device token for the GCM, APNS, and APNS_SANDBOX endpoint types.
endpointAttributes_voipDeviceToken :: Lens' EndpointAttributes (Maybe Text) Source #
The VOIP device token for the APNS and APNS_SANDBOX endpoint types.
endpointAttributes_deviceToken :: Lens' EndpointAttributes Text Source #
The device token for the GCM, APNS, and APNS_SANDBOX endpoint types.
EndpointState
data EndpointState Source #
A read-only field that represents the state of an
AppInstanceUserEndpoint
. Supported values:
ACTIVE
: TheAppInstanceUserEndpoint
is active and able to receive messages. WhenACTIVE
, theEndpointStatusReason
remains empty.INACTIVE
: TheAppInstanceUserEndpoint
is inactive and can't receive message. When INACTIVE, the corresponding reason will be conveyed through EndpointStatusReason.INVALID_DEVICE_TOKEN
indicates that anAppInstanceUserEndpoint
isINACTIVE
due to invalid device tokenINVALID_PINPOINT_ARN
indicates that anAppInstanceUserEndpoint
isINACTIVE
due to an invalid pinpoint ARN that was input through theResourceArn
field.
See: newEndpointState
smart constructor.
EndpointState' | |
|
Instances
Create a value of EndpointState
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:statusReason:EndpointState'
, endpointState_statusReason
- The reason for the EndpointStatus
.
$sel:status:EndpointState'
, endpointState_status
- Enum that indicates the Status of an AppInstanceUserEndpoint
.
endpointState_statusReason :: Lens' EndpointState (Maybe EndpointStatusReason) Source #
The reason for the EndpointStatus
.
endpointState_status :: Lens' EndpointState EndpointStatus Source #
Enum that indicates the Status of an AppInstanceUserEndpoint
.
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.ChimeSDKIdentity.Types.Identity | |
Eq Identity Source # | |
Hashable Identity Source # | |
Defined in Amazonka.ChimeSDKIdentity.Types.Identity | |
type Rep Identity Source # | |
Defined in Amazonka.ChimeSDKIdentity.Types.Identity type Rep Identity = D1 ('MetaData "Identity" "Amazonka.ChimeSDKIdentity.Types.Identity" "amazonka-chime-sdk-identity-2.0-4Oyp0DV6v8255OObqkKpjC" '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.
Tag
A tag object containing a key-value pair.
See: newTag
smart constructor.
Instances
FromJSON Tag Source # | |
ToJSON Tag Source # | |
Defined in Amazonka.ChimeSDKIdentity.Types.Tag | |
Generic Tag Source # | |
Show Tag Source # | |
NFData Tag Source # | |
Defined in Amazonka.ChimeSDKIdentity.Types.Tag | |
Eq Tag Source # | |
Hashable Tag Source # | |
Defined in Amazonka.ChimeSDKIdentity.Types.Tag | |
type Rep Tag Source # | |
Defined in Amazonka.ChimeSDKIdentity.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.ChimeSDKIdentity.Types.Tag" "amazonka-chime-sdk-identity-2.0-4Oyp0DV6v8255OObqkKpjC" '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.