DescribeGateway
Retrieves information about a gateway.
Request Syntax
GET /20200301/gateways/gatewayId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- gatewayId
-
The ID of the gateway device.
Length Constraints: Fixed length of 36.
Pattern:
^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"creationDate": number,
"gatewayArn": "string",
"gatewayCapabilitySummaries": [
{
"capabilityNamespace": "string",
"capabilitySyncStatus": "string"
}
],
"gatewayId": "string",
"gatewayName": "string",
"gatewayPlatform": {
"greengrass": {
"groupArn": "string"
},
"greengrassV2": {
"coreDeviceOperatingSystem": "string",
"coreDeviceThingName": "string"
},
"siemensIE": {
"iotCoreThingName": "string"
}
},
"gatewayVersion": "string",
"lastUpdateDate": number
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- creationDate
-
The date the gateway was created, in Unix epoch time.
Type: Timestamp
- gatewayArn
-
The ARN of the gateway, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:gateway/${GatewayId}Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern:
^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.]+$ - gatewayCapabilitySummaries
-
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.
Type: Array of GatewayCapabilitySummary objects
- gatewayId
-
The ID of the gateway device.
Type: String
Length Constraints: Fixed length of 36.
Pattern:
^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ - gatewayName
-
The name of the gateway.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[^\u0000-\u001F\u007F]+ - gatewayPlatform
-
The gateway's platform.
Type: GatewayPlatform object
- gatewayVersion
-
The version of the gateway. A value of
3indicates an MQTT-enabled, V3 gateway, while2indicates a Classic streams, V2 gateway.Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
^[0-9]+$ - lastUpdateDate
-
The date the gateway was last updated, in Unix epoch time.
Type: Timestamp
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalFailureException
-
AWS IoT SiteWise can't process your request right now. Try again later.
HTTP Status Code: 500
- InvalidRequestException
-
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
HTTP Status Code: 400
- ResourceNotFoundException
-
The requested resource can't be found.
HTTP Status Code: 404
- ThrottlingException
-
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS 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 AWS IoT SiteWise User Guide.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
