DescribeGatewayCommand

Suggest an Edit

Retrieves information about a gateway.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { IoTSiteWiseClient, DescribeGatewayCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
// const { IoTSiteWiseClient, DescribeGatewayCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
const client = new IoTSiteWiseClient(config);
const input = { // DescribeGatewayRequest
  gatewayId: "STRING_VALUE", // required
};
const command = new DescribeGatewayCommand(input);
const response = await client.send(command);
// { // DescribeGatewayResponse
//   gatewayId: "STRING_VALUE", // required
//   gatewayName: "STRING_VALUE", // required
//   gatewayArn: "STRING_VALUE", // required
//   gatewayPlatform: { // GatewayPlatform
//     greengrass: { // Greengrass
//       groupArn: "STRING_VALUE", // required
//     },
//     greengrassV2: { // GreengrassV2
//       coreDeviceThingName: "STRING_VALUE", // required
//       coreDeviceOperatingSystem: "LINUX_AARCH64" || "LINUX_AMD64" || "WINDOWS_AMD64",
//     },
//     siemensIE: { // SiemensIE
//       iotCoreThingName: "STRING_VALUE", // required
//     },
//   },
//   gatewayVersion: "STRING_VALUE",
//   gatewayCapabilitySummaries: [ // GatewayCapabilitySummaries // required
//     { // GatewayCapabilitySummary
//       capabilityNamespace: "STRING_VALUE", // required
//       capabilitySyncStatus: "IN_SYNC" || "OUT_OF_SYNC" || "SYNC_FAILED" || "UNKNOWN" || "NOT_APPLICABLE", // required
//     },
//   ],
//   creationDate: new Date("TIMESTAMP"), // required
//   lastUpdateDate: new Date("TIMESTAMP"), // required
// };

DescribeGatewayCommand Input

See DescribeGatewayCommandInput for more details

Parameter
Type
Description
gatewayId
Required
string | undefined

The ID of the gateway device.

DescribeGatewayCommand Output

See DescribeGatewayCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
creationDate
Required
Date | undefined

The date the gateway was created, in Unix epoch time.

gatewayArn
Required
string | undefined

The ARN  of the gateway, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:gateway/${GatewayId}

gatewayCapabilitySummaries
Required
GatewayCapabilitySummary[] | undefined

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 DescribeGatewayCapabilityConfiguration .

gatewayId
Required
string | undefined

The ID of the gateway device.

gatewayName
Required
string | undefined

The name of the gateway.

lastUpdateDate
Required
Date | undefined

The date the gateway was last updated, in Unix epoch time.

gatewayPlatform
GatewayPlatform | undefined

The gateway's platform.

gatewayVersion
string | undefined

The version of the gateway. A value of 3 indicates an MQTT-enabled, V3 gateway, while 2 indicates a Classic streams, V2 gateway.

Throws

Name
Fault
Details
InternalFailureException
server

IoT SiteWise can't process your request right now. Try again later.

InvalidRequestException
client

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

ResourceNotFoundException
client

The requested resource can't be found.

ThrottlingException
client

Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas  in the IoT SiteWise User Guide.

IoTSiteWiseServiceException
Base exception class for all service exceptions from IoTSiteWise service.