---
title: "GET /20200301/gateways/{gatewayId}"
method: GET
path: "/20200301/gateways/{gatewayId}"
---

# GET /20200301/gateways/{gatewayId}

`GET /20200301/gateways/{gatewayId}`

Retrieves information about a gateway.

## Path parameters

- `gatewayId` string, required

## Response `200`

Success

- DescribeGatewayResponse
  - `gatewayId` string, required — The ID of the gateway device.
  - `gatewayName` string, required — The name of the gateway.
  - `gatewayArn` string, required — <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the gateway, which has the following format.</p> <p> <code>arn:${Partition}:iotsitewise:${Region}:${Account}:gateway/${GatewayId}</code> </p>
  - `gatewayPlatform` object — The gateway's platform.
    - `greengrass` object — A gateway that runs on IoT Greengrass.
      - `groupArn` string, required — The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the Greengrass group. For more information about how to find a group's ARN, see <a href="https://docs.aws.amazon.com/greengrass/latest/apireference/listgroups-get.html">ListGroups</a> and <a href="https://docs.aws.amazon.com/greengrass/latest/apireference/getgroup-get.html">GetGroup</a> in the <i>IoT Greengrass API Reference</i>.
    - `greengrassV2` object — A gateway that runs on IoT Greengrass V2.
      - `coreDeviceThingName` string, required — The name of the IoT thing for your IoT Greengrass V2 core device.
  - `gatewayCapabilitySummaries` GatewayCapabilitySummary[], required — A list of gateway capability summaries that each contain a namespace and status. Each gateway capability defines data sources for the gateway. To retrieve a capability configuration's definition, use <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeGatewayCapabilityConfiguration.html">DescribeGatewayCapabilityConfiguration</a>.
    - `capabilityNamespace` string, required — The namespace of the capability configuration. For example, if you configure OPC-UA sources from the IoT SiteWise console, your OPC-UA capability configuration has the namespace <code>iotsitewise:opcuacollector:version</code>, where <code>version</code> is a number such as <code>1</code>.
    - `capabilitySyncStatus` 'IN_SYNC' | 'OUT_OF_SYNC' | 'SYNC_FAILED' | 'UNKNOWN', required — <p>The synchronization status of the capability configuration. The sync status can be one of the following:</p> <ul> <li> <p> <code>IN_SYNC</code> – The gateway is running the capability configuration.</p> </li> <li> <p> <code>OUT_OF_SYNC</code> – The gateway hasn't received the capability configuration.</p> </li> <li> <p> <code>SYNC_FAILED</code> – The gateway rejected the capability configuration.</p> </li> </ul>
  - `creationDate` string, date-time, required — The date the gateway was created, in Unix epoch time.
  - `lastUpdateDate` string, date-time, required — The date the gateway was last updated, in Unix epoch time.

## Other responses

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

---

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