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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-chimesdkidentity/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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#statusString

Enum that indicates the Status of an AppInstanceUserEndpoint.

Returns:

  • (String)


701
702
703
704
705
706
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/types.rb', line 701

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

#status_reasonString

The reason for the EndpointStatus.

Returns:

  • (String)


701
702
703
704
705
706
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/types.rb', line 701

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