AWaws-samples
Virtual Desktops

POST /api/dcv/session-event

Changed on

POST operation for /api/dcv/session-event

post/api/dcv/session-event

Request

  • The document declares no server URL.
  • Auth
    socaAuth (a scheme the document does not define) and socaToken (a scheme the document does not define)

Headers

X-EDH-Attested-Instancestring required

AWS-attested EC2 instance ID (set by relay Lambda from SQS SenderId) or control-plane principal name

X-EDH-DcvRelay-HMACstring required

Base64-encoded HMAC-SHA-256 signature over the canonical request, keyed by the relay secret

Request body

event_type'placed' | 'placement_failed' | 'session-ready' | 'session-resumed' | 'session-failed' | 'session-heartbeat' | 'bootstrap-checkpoint' | 'bootstrap-status' required

The lifecycle event type

session_uuidstring uuid required

UUID of the DCV session

instance_idstring required

EC2 instance ID (not required for control-plane callers)

event_timestampstring date-time required

ISO-8601 timestamp of the event (must be within 5 min of server time)

noncestring required

Unique nonce for replay protection

checkpointstring

Bootstrap checkpoint name (required for bootstrap-checkpoint events)

sub_statusstring

Free-form progress message (required for bootstrap-status events)

Response

Event accepted and applied successfully

Changes