{
  "schema_version": 2,
  "id": "operate/rs/references/rest-api/objects/state-machine",
  "title": "State machine object",
  "url": "https://redis.io/docs/latest/operate/rs/references/rest-api/objects/state-machine/",
  "summary": "An object that represents a state machine.",
  "tags": [
    "docs",
    "operate",
    "rs"
  ],
  "last_updated": "2023-12-14T15:27:49+01:00",
  "page_type": "content",
  "content_hash": "70adadcaa1e5904233462122951a40e01c77f17243371c47c9fdc3295dbcee3f",
  "sections": [
    {
      "id": "content",
      "title": "Content",
      "role": "content",
      "text": "A state machine object tracks the status of database actions.\n\nA state machine contains the following attributes:\n\n| Name        | Type/Value | Description |\n|-------------|------------|-------------|\n| action_uid  | string     | A globally unique identifier of the action |\n| object_name | string     | Name of the object being manipulated by the state machine |\n| status      | pending    | Requested state machine has not started |\n|             | active     | State machine is currently running |\n|             | completed  | Operation complete |\n|             | failed     | Operation or state machine failed |\n| name        | string     | Name of the running (or failed) state machine |\n| state       | string     | Current state within the state machine, when known |\n| error       | string     | A descriptive error string for failed state machine, when known |"
    }
  ],
  "examples": []
}