EndpointState
import type { EndpointState } from "https://aws-api.deno.dev/v0.4/services/chimesdkidentity.ts?docs=full";
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.
§Properties
§
Status: EndpointStatus
[src]Enum that indicates the Status of an AppInstanceUserEndpoint
.
§
StatusReason?: EndpointStatusReason | null
[src]The reason for the EndpointStatus
.