Class: Aws::ChimeSDKIdentity::Types::EndpointState

Inherits:

Struct

• Object
• Struct
• Aws::ChimeSDKIdentity::Types::EndpointState

Includes:

Structure

Defined in:

lib/aws-sdk-chimesdkidentity/types.rb

Overview

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.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #status ⇒ String

  Enum that indicates the Status of an ‘AppInstanceUserEndpoint`.

• #status_reason ⇒ String

  The reason for the ‘EndpointStatus`.

Instance Attribute Details

#status ⇒ String

Enum that indicates the Status of an ‘AppInstanceUserEndpoint`.

Returns:

• (String)

# File 'lib/aws-sdk-chimesdkidentity/types.rb', line 883

class EndpointState < Struct.new(
  :status,
  :status_reason)
  SENSITIVE = []
  include Aws::Structure
end

#status_reason ⇒ String

The reason for the ‘EndpointStatus`.

Returns:

• (String)

# File 'lib/aws-sdk-chimesdkidentity/types.rb', line 883

class EndpointState < Struct.new(
  :status,
  :status_reason)
  SENSITIVE = []
  include Aws::Structure
end