---
title: "GET /detector-models/{detectorModelName}"
method: GET
path: "/detector-models/{detectorModelName}"
---

# GET /detector-models/{detectorModelName}

`GET /detector-models/{detectorModelName}`

Describes a detector model. If the <code>version</code> parameter is not specified, information about the latest version is returned.

## Path parameters

- `detectorModelName` string, required

## Query parameters

- `version` string

## Response `200`

Success

- DescribeDetectorModelResponse
  - `detectorModel` object — Information about the detector model.
    - `detectorModelDefinition` object — Information that defines how a detector operates.
      - `states` State[], required — Information about the states of the detector.
        - `stateName` string, required — The name of the state.
        - `onInput` object — When an input is received and the <code>condition</code> is TRUE, perform the specified <code>actions</code>.
          - `events` Event[] — Specifies the actions performed when the <code>condition</code> evaluates to TRUE.
            - `eventName` string, required — The name of the event.
            - `condition` string — Optional. The Boolean expression that, when TRUE, causes the <code>actions</code> to be performed. If not present, the actions are performed (=TRUE). If the expression result is not a Boolean value, the actions are not performed (=FALSE).
            - `actions` Action[] — The actions to be performed.
              - …
          - `transitionEvents` TransitionEvent[] — Specifies the actions performed, and the next state entered, when a <code>condition</code> evaluates to TRUE.
            - `eventName` string, required — The name of the transition event.
            - `condition` string, required — Required. A Boolean expression that when TRUE causes the actions to be performed and the <code>nextState</code> to be entered.
            - `actions` Action[] — The actions to be performed.
              - …
            - `nextState` string, required — The next state to enter.
        - `onEnter` object — When entering this state, perform these <code>actions</code> if the <code>condition</code> is TRUE.
          - `events` Event[] — Specifies the actions that are performed when the state is entered and the <code>condition</code> is <code>TRUE</code>.
            - `eventName` string, required — The name of the event.
            - `condition` string — Optional. The Boolean expression that, when TRUE, causes the <code>actions</code> to be performed. If not present, the actions are performed (=TRUE). If the expression result is not a Boolean value, the actions are not performed (=FALSE).
            - `actions` Action[] — The actions to be performed.
              - …
        - `onExit` object — When exiting this state, perform these <code>actions</code> if the specified <code>condition</code> is <code>TRUE</code>.
          - `events` Event[] — Specifies the <code>actions</code> that are performed when the state is exited and the <code>condition</code> is <code>TRUE</code>.
            - `eventName` string, required — The name of the event.
            - `condition` string — Optional. The Boolean expression that, when TRUE, causes the <code>actions</code> to be performed. If not present, the actions are performed (=TRUE). If the expression result is not a Boolean value, the actions are not performed (=FALSE).
            - `actions` Action[] — The actions to be performed.
              - …
      - `initialStateName` string, required — The state that is entered at the creation of each detector (instance).
    - `detectorModelConfiguration` object — Information about how the detector is configured.
      - `detectorModelName` string — The name of the detector model.
      - `detectorModelVersion` string — The version of the detector model.
      - `detectorModelDescription` string — A brief description of the detector model.
      - `detectorModelArn` string — The ARN of the detector model.
      - `roleArn` string — The ARN of the role that grants permission to AWS IoT Events to perform its operations.
      - `creationTime` string, date-time — The time the detector model was created.
      - `lastUpdateTime` string, date-time — The time the detector model was last updated.
      - `status` 'ACTIVE' | 'ACTIVATING' | 'INACTIVE' | 'DEPRECATED' | 'DRAFT' | 'PAUSED' | 'FAILED' — The status of the detector model.
      - `key` string — <p>The value used to identify a detector instance. When a device or system sends input, a new detector instance with a unique key value is created. AWS IoT Events can continue to route input to its corresponding detector instance based on this identifying information. </p> <p>This parameter uses a JSON-path expression to select the attribute-value pair in the message payload that is used for identification. To route the message to the correct detector instance, the device must send a message payload that contains the same attribute-value.</p>
      - `evaluationMethod` 'BATCH' | 'SERIAL' — Information about the order in which events are evaluated and how actions are executed.

## Other responses

- `480` — InvalidRequestException
- `481` — ResourceNotFoundException
- `482` — ThrottlingException
- `483` — InternalFailureException
- `484` — ServiceUnavailableException

---

[API](https://skmtc.net/aws/apis/iotevents.md) · [All operations](https://skmtc.net/aws/apis/iotevents/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/iotevents/versions/d3ae7b052b1d/schema)