---
title: "GET /inputs/{inputName}"
method: GET
path: "/inputs/{inputName}"
---

# GET /inputs/{inputName}

`GET /inputs/{inputName}`

Describes an input.

## Path parameters

- `inputName` string, required

## Response `200`

Success

- DescribeInputResponse
  - `input` object — Information about the input.
    - `inputConfiguration` object — Information about the configuration of an input.
      - `inputName` string, required — The name of the input.
      - `inputDescription` string — A brief description of the input.
      - `inputArn` string, required — The ARN of the input.
      - `creationTime` string, date-time, required — The time the input was created.
      - `lastUpdateTime` string, date-time, required — The last time the input was updated.
      - `status` 'CREATING' | 'UPDATING' | 'ACTIVE' | 'DELETING', required — The status of the input.
    - `inputDefinition` object — The definition of the input.
      - `attributes` Attribute[], required — The attributes from the JSON payload that are made available by the input. Inputs are derived from messages sent to the AWS IoT Events system using <code>BatchPutMessage</code>. Each such message contains a JSON payload, and those attributes (and their paired values) specified here are available for use in the <code>condition</code> expressions used by detectors that monitor this input.
        - `jsonPath` string, required — <p>An expression that specifies an attribute-value pair in a JSON structure. Use this to specify an attribute from the JSON payload that is made available by the input. Inputs are derived from messages sent to AWS IoT Events (<code>BatchPutMessage</code>). Each such message contains a JSON payload. The attribute (and its paired value) specified here are available for use in the <code>condition</code> expressions used by detectors. </p> <p>Syntax: <code>&lt;field-name&gt;.&lt;field-name&gt;...</code> </p>

## 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)