Amazonka.ChimeSDKIdentity.Types.EndpointState

Documentation

data 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.

See: newEndpointState smart constructor.

Constructors

EndpointState'

Fields

• statusReason :: Maybe EndpointStatusReason

  The reason for the EndpointStatus.

• status :: EndpointStatus

  Enum that indicates the Status of an AppInstanceUserEndpoint.

Instances

FromJSON EndpointState

Defined in Amazonka.ChimeSDKIdentity.Types.EndpointState

Methods

parseJSON :: Value -> Parser EndpointState

parseJSONList :: Value -> Parser [EndpointState]

Generic EndpointState

Defined in Amazonka.ChimeSDKIdentity.Types.EndpointState

Associated Types

type Rep EndpointState :: Type -> Type

Methods

from :: EndpointState -> Rep EndpointState x

to :: Rep EndpointState x -> EndpointState

Read EndpointState

Defined in Amazonka.ChimeSDKIdentity.Types.EndpointState

Methods

readsPrec :: Int -> ReadS EndpointState

readList :: ReadS [EndpointState]

readPrec :: ReadPrec EndpointState

readListPrec :: ReadPrec [EndpointState]

Show EndpointState

Defined in Amazonka.ChimeSDKIdentity.Types.EndpointState

Methods

showsPrec :: Int -> EndpointState -> ShowS

show :: EndpointState -> String

showList :: [EndpointState] -> ShowS

NFData EndpointState

Defined in Amazonka.ChimeSDKIdentity.Types.EndpointState

Methods

rnf :: EndpointState -> ()

Eq EndpointState

Defined in Amazonka.ChimeSDKIdentity.Types.EndpointState

Methods

(==) :: EndpointState -> EndpointState -> Bool

(/=) :: EndpointState -> EndpointState -> Bool

Hashable EndpointState

Defined in Amazonka.ChimeSDKIdentity.Types.EndpointState

Methods

hashWithSalt :: Int -> EndpointState -> Int

hash :: EndpointState -> Int

type Rep EndpointState

Defined in Amazonka.ChimeSDKIdentity.Types.EndpointState

type Rep EndpointState = D1 ('MetaData "EndpointState" "Amazonka.ChimeSDKIdentity.Types.EndpointState" "amazonka-chime-sdk-identity-2.0-4Oyp0DV6v8255OObqkKpjC" 'False) (C1 ('MetaCons "EndpointState'" 'PrefixI 'True) (S1 ('MetaSel ('Just "statusReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EndpointStatusReason)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 EndpointStatus)))

newEndpointState

Arguments

:: EndpointStatus

$sel:status:EndpointState'

-> EndpointState

Create a value of EndpointState with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:statusReason:EndpointState', endpointState_statusReason - The reason for the EndpointStatus.

$sel:status:EndpointState', endpointState_status - Enum that indicates the Status of an AppInstanceUserEndpoint.

endpointState_statusReason :: Lens' EndpointState (Maybe EndpointStatusReason)

The reason for the EndpointStatus.

endpointState_status :: Lens' EndpointState EndpointStatus

Enum that indicates the Status of an AppInstanceUserEndpoint.