AppInstanceUserEndpointSummary - Amazon Chime SDK
ContentsSee Also

AppInstanceUserEndpointSummary

Summary of the details of an AppInstanceUserEndpoint.

Contents

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.

Type: String

Valid Values: ALL | NONE

Required: No

AppInstanceUserArn

The ARN of the AppInstanceUser.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Required: No

EndpointId

The unique identifier of the AppInstanceUserEndpoint.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 64.

Pattern: .*

Required: No

EndpointState

A read-only field that represent the state of an AppInstanceUserEndpoint.

Type: EndpointState object

Required: No

Name

The name of the AppInstanceUserEndpoint.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1600.

Pattern: .*

Required: No

Type

The type of the AppInstanceUserEndpoint.

Type: String

Valid Values: APNS | APNS_SANDBOX | GCM

Required: No

See Also

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