AppInstanceUserEndpoint

import type { AppInstanceUserEndpoint } from "https://aws-api.deno.dev/v0.4/services/chimesdkidentity.ts?docs=full";

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.

interface AppInstanceUserEndpoint {

AllowMessages?: AllowMessages | null;

AppInstanceUserArn?: string | null;

CreatedTimestamp?: Date | number | null;

EndpointAttributes?: EndpointAttributes | null;

EndpointId?: string | null;

EndpointState?: EndpointState | null;

LastUpdatedTimestamp?: Date | number | null;

Name?: string | null;

ResourceArn?: string | null;

Type?: AppInstanceUserEndpointType | null;

}

§Properties

AllowMessages?: AllowMessages | null

[src]

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.

AppInstanceUserArn?: string | null

[src]

The ARN of the AppInstanceUser.

CreatedTimestamp?: Date | number | null

[src]

The time at which an AppInstanceUserEndpoint was created.

EndpointAttributes?: EndpointAttributes | null

[src]

The attributes of an Endpoint.

EndpointId?: string | null

[src]

The unique identifier of the AppInstanceUserEndpoint.

EndpointState?: EndpointState | null

[src]

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.

LastUpdatedTimestamp?: Date | number | null

[src]

The time at which an AppInstanceUserEndpoint was last updated.

Name?: string | null

[src]

The name of the AppInstanceUserEndpoint.

ResourceArn?: string | null

[src]

The ARN of the resource to which the endpoint belongs.

Type?: AppInstanceUserEndpointType | null

[src]

The type of the AppInstanceUserEndpoint.