/AWS1/CL_CHIAPPINSTUSERENDPT

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.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_appinstanceuserarn TYPE /AWS1/CHICHIMEARN /AWS1/CHICHIMEARN

The ARN of the AppInstanceUser.

iv_endpointid TYPE /AWS1/CHISTRING64 /AWS1/CHISTRING64

The unique identifier of the AppInstanceUserEndpoint.

iv_name TYPE /AWS1/CHISENSITIVESTRING1600 /AWS1/CHISENSITIVESTRING1600

The name of the AppInstanceUserEndpoint.

iv_type TYPE /AWS1/CHIAPPINSTUSERENDPTTYPE /AWS1/CHIAPPINSTUSERENDPTTYPE

The type of the AppInstanceUserEndpoint.

iv_resourcearn TYPE /AWS1/CHICHIMEARN /AWS1/CHICHIMEARN

The ARN of the resource to which the endpoint belongs.

io_endpointattributes TYPE REF TO /AWS1/CL_CHIENDPOINTATTRIBUTES /AWS1/CL_CHIENDPOINTATTRIBUTES

The attributes of an Endpoint.

iv_createdtimestamp TYPE /AWS1/CHITIMESTAMP /AWS1/CHITIMESTAMP

The time at which an AppInstanceUserEndpoint was created.

iv_lastupdatedtimestamp TYPE /AWS1/CHITIMESTAMP /AWS1/CHITIMESTAMP

The time at which an AppInstanceUserEndpoint was last updated.

iv_allowmessages TYPE /AWS1/CHIALLOWMESSAGES /AWS1/CHIALLOWMESSAGES

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.

io_endpointstate TYPE REF TO /AWS1/CL_CHIENDPOINTSTATE /AWS1/CL_CHIENDPOINTSTATE

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.

---

Queryable Attributes

AppInstanceUserArn

The ARN of the AppInstanceUser.

Accessible with the following methods

Method	Description
GET_APPINSTANCEUSERARN()	Getter for APPINSTANCEUSERARN, with configurable default
ASK_APPINSTANCEUSERARN()	Getter for APPINSTANCEUSERARN w/ exceptions if field has no
HAS_APPINSTANCEUSERARN()	Determine if APPINSTANCEUSERARN has a value

EndpointId

The unique identifier of the AppInstanceUserEndpoint.

Accessible with the following methods

Method	Description
GET_ENDPOINTID()	Getter for ENDPOINTID, with configurable default
ASK_ENDPOINTID()	Getter for ENDPOINTID w/ exceptions if field has no value
HAS_ENDPOINTID()	Determine if ENDPOINTID has a value

Name

The name of the AppInstanceUserEndpoint.

Accessible with the following methods

Method	Description
GET_NAME()	Getter for NAME, with configurable default
ASK_NAME()	Getter for NAME w/ exceptions if field has no value
HAS_NAME()	Determine if NAME has a value

Type

The type of the AppInstanceUserEndpoint.

Accessible with the following methods

Method	Description
GET_TYPE()	Getter for TYPE, with configurable default
ASK_TYPE()	Getter for TYPE w/ exceptions if field has no value
HAS_TYPE()	Determine if TYPE has a value

ResourceArn

The ARN of the resource to which the endpoint belongs.

Accessible with the following methods

Method	Description
GET_RESOURCEARN()	Getter for RESOURCEARN, with configurable default
ASK_RESOURCEARN()	Getter for RESOURCEARN w/ exceptions if field has no value
HAS_RESOURCEARN()	Determine if RESOURCEARN has a value

EndpointAttributes

The attributes of an Endpoint.

Accessible with the following methods

Method	Description
GET_ENDPOINTATTRIBUTES()	Getter for ENDPOINTATTRIBUTES

CreatedTimestamp

The time at which an AppInstanceUserEndpoint was created.

Accessible with the following methods

Method	Description
GET_CREATEDTIMESTAMP()	Getter for CREATEDTIMESTAMP, with configurable default
ASK_CREATEDTIMESTAMP()	Getter for CREATEDTIMESTAMP w/ exceptions if field has no va
HAS_CREATEDTIMESTAMP()	Determine if CREATEDTIMESTAMP has a value

LastUpdatedTimestamp

The time at which an AppInstanceUserEndpoint was last updated.

Accessible with the following methods

Method	Description
GET_LASTUPDATEDTIMESTAMP()	Getter for LASTUPDATEDTIMESTAMP, with configurable default
ASK_LASTUPDATEDTIMESTAMP()	Getter for LASTUPDATEDTIMESTAMP w/ exceptions if field has n
HAS_LASTUPDATEDTIMESTAMP()	Determine if LASTUPDATEDTIMESTAMP has a value

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.

Accessible with the following methods

Method	Description
GET_ALLOWMESSAGES()	Getter for ALLOWMESSAGES, with configurable default
ASK_ALLOWMESSAGES()	Getter for ALLOWMESSAGES w/ exceptions if field has no value
HAS_ALLOWMESSAGES()	Determine if ALLOWMESSAGES has a value

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.

Accessible with the following methods

Method	Description
GET_ENDPOINTSTATE()	Getter for ENDPOINTSTATE