Amazonka.ChimeSDKIdentity.Types.AppInstanceUserEndpoint

Documentation

data AppInstanceUserEndpoint

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.

See: newAppInstanceUserEndpoint smart constructor.

Constructors

AppInstanceUserEndpoint'

Fields

• allowMessages :: Maybe 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.

• appInstanceUserArn :: Maybe (Sensitive Text)

  The ARN of the AppInstanceUser.

• createdTimestamp :: Maybe POSIX

  The time at which an AppInstanceUserEndpoint was created.

• endpointAttributes :: Maybe EndpointAttributes

  The attributes of an Endpoint.

• endpointId :: Maybe (Sensitive Text)

  The unique identifier of the AppInstanceUserEndpoint.

• endpointState :: Maybe 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.
• lastUpdatedTimestamp :: Maybe POSIX

  The time at which an AppInstanceUserEndpoint was last updated.

• name :: Maybe (Sensitive Text)

  The name of the AppInstanceUserEndpoint.

• resourceArn :: Maybe (Sensitive Text)

  The ARN of the resource to which the endpoint belongs.

• type' :: Maybe AppInstanceUserEndpointType

  The type of the AppInstanceUserEndpoint.

Instances

FromJSON AppInstanceUserEndpoint

Defined in Amazonka.ChimeSDKIdentity.Types.AppInstanceUserEndpoint

Methods

parseJSON :: Value -> Parser AppInstanceUserEndpoint

parseJSONList :: Value -> Parser [AppInstanceUserEndpoint]

Generic AppInstanceUserEndpoint

Defined in Amazonka.ChimeSDKIdentity.Types.AppInstanceUserEndpoint

Associated Types

type Rep AppInstanceUserEndpoint :: Type -> Type

Methods

from :: AppInstanceUserEndpoint -> Rep AppInstanceUserEndpoint x

to :: Rep AppInstanceUserEndpoint x -> AppInstanceUserEndpoint

Show AppInstanceUserEndpoint

Defined in Amazonka.ChimeSDKIdentity.Types.AppInstanceUserEndpoint

Methods

showsPrec :: Int -> AppInstanceUserEndpoint -> ShowS

show :: AppInstanceUserEndpoint -> String

showList :: [AppInstanceUserEndpoint] -> ShowS

NFData AppInstanceUserEndpoint

Defined in Amazonka.ChimeSDKIdentity.Types.AppInstanceUserEndpoint

Methods

rnf :: AppInstanceUserEndpoint -> ()

Eq AppInstanceUserEndpoint

Defined in Amazonka.ChimeSDKIdentity.Types.AppInstanceUserEndpoint

Methods

(==) :: AppInstanceUserEndpoint -> AppInstanceUserEndpoint -> Bool

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

Hashable AppInstanceUserEndpoint

Defined in Amazonka.ChimeSDKIdentity.Types.AppInstanceUserEndpoint

Methods

hashWithSalt :: Int -> AppInstanceUserEndpoint -> Int

hash :: AppInstanceUserEndpoint -> Int

type Rep AppInstanceUserEndpoint

Defined in Amazonka.ChimeSDKIdentity.Types.AppInstanceUserEndpoint

type Rep AppInstanceUserEndpoint = D1 ('MetaData "AppInstanceUserEndpoint" "Amazonka.ChimeSDKIdentity.Types.AppInstanceUserEndpoint" "amazonka-chime-sdk-identity-2.0-4Oyp0DV6v8255OObqkKpjC" 'False) (C1 ('MetaCons "AppInstanceUserEndpoint'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "allowMessages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AllowMessages)) :*: S1 ('MetaSel ('Just "appInstanceUserArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text)))) :*: (S1 ('MetaSel ('Just "createdTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "endpointAttributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EndpointAttributes)) :*: S1 ('MetaSel ('Just "endpointId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text)))))) :*: ((S1 ('MetaSel ('Just "endpointState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EndpointState)) :*: S1 ('MetaSel ('Just "lastUpdatedTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: (S1 ('MetaSel ('Just "resourceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AppInstanceUserEndpointType)))))))

newAppInstanceUserEndpoint :: AppInstanceUserEndpoint

Create a value of AppInstanceUserEndpoint 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:allowMessages:AppInstanceUserEndpoint', appInstanceUserEndpoint_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.

$sel:appInstanceUserArn:AppInstanceUserEndpoint', appInstanceUserEndpoint_appInstanceUserArn - The ARN of the AppInstanceUser.

$sel:createdTimestamp:AppInstanceUserEndpoint', appInstanceUserEndpoint_createdTimestamp - The time at which an AppInstanceUserEndpoint was created.

$sel:endpointAttributes:AppInstanceUserEndpoint', appInstanceUserEndpoint_endpointAttributes - The attributes of an Endpoint.

$sel:endpointId:AppInstanceUserEndpoint', appInstanceUserEndpoint_endpointId - The unique identifier of the AppInstanceUserEndpoint.

$sel:endpointState:AppInstanceUserEndpoint', appInstanceUserEndpoint_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.

$sel:lastUpdatedTimestamp:AppInstanceUserEndpoint', appInstanceUserEndpoint_lastUpdatedTimestamp - The time at which an AppInstanceUserEndpoint was last updated.

$sel:name:AppInstanceUserEndpoint', appInstanceUserEndpoint_name - The name of the AppInstanceUserEndpoint.

$sel:resourceArn:AppInstanceUserEndpoint', appInstanceUserEndpoint_resourceArn - The ARN of the resource to which the endpoint belongs.

$sel:type':AppInstanceUserEndpoint', appInstanceUserEndpoint_type - The type of the AppInstanceUserEndpoint.

appInstanceUserEndpoint_allowMessages :: Lens' AppInstanceUserEndpoint (Maybe 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.

appInstanceUserEndpoint_appInstanceUserArn :: Lens' AppInstanceUserEndpoint (Maybe Text)

The ARN of the AppInstanceUser.

appInstanceUserEndpoint_createdTimestamp :: Lens' AppInstanceUserEndpoint (Maybe UTCTime)

The time at which an AppInstanceUserEndpoint was created.

appInstanceUserEndpoint_endpointAttributes :: Lens' AppInstanceUserEndpoint (Maybe EndpointAttributes)

The attributes of an Endpoint.

appInstanceUserEndpoint_endpointId :: Lens' AppInstanceUserEndpoint (Maybe Text)

The unique identifier of the AppInstanceUserEndpoint.

appInstanceUserEndpoint_endpointState :: Lens' AppInstanceUserEndpoint (Maybe 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.

appInstanceUserEndpoint_lastUpdatedTimestamp :: Lens' AppInstanceUserEndpoint (Maybe UTCTime)

The time at which an AppInstanceUserEndpoint was last updated.

appInstanceUserEndpoint_name :: Lens' AppInstanceUserEndpoint (Maybe Text)

The name of the AppInstanceUserEndpoint.

appInstanceUserEndpoint_resourceArn :: Lens' AppInstanceUserEndpoint (Maybe Text)

The ARN of the resource to which the endpoint belongs.

appInstanceUserEndpoint_type :: Lens' AppInstanceUserEndpoint (Maybe AppInstanceUserEndpointType)

The type of the AppInstanceUserEndpoint.