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 |
Synopsis
- 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)
Documentation
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
.