EndpointState - Amazon Chime SDK
ContentsSee Also

EndpointState

A read-only field that represents the state of an AppInstanceUserEndpoint. Supported values:

  • ACTIVE: The AppInstanceUserEndpoint is active and able to receive messages. When ACTIVE, the EndpointStatusReason remains empty.

  • INACTIVE: The AppInstanceUserEndpoint is inactive and can't receive message. When INACTIVE, the corresponding reason will be conveyed through EndpointStatusReason.

  • INVALID_DEVICE_TOKEN indicates that an AppInstanceUserEndpoint is INACTIVE due to invalid device token

  • INVALID_PINPOINT_ARN indicates that an AppInstanceUserEndpoint is INACTIVE due to an invalid pinpoint ARN that was input through the ResourceArn field.

Contents

Status

Enum that indicates the Status of an AppInstanceUserEndpoint.

Type: String

Valid Values: ACTIVE | INACTIVE

Required: Yes

StatusReason

The reason for the EndpointStatus.

Type: String

Valid Values: INVALID_DEVICE_TOKEN | INVALID_PINPOINT_ARN

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: