Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DescribeGatewayCapabilityConfiguration

Each gateway capability defines data sources for a gateway. This is the namespace of the gateway capability.

. The namespace follows the format service:capability:version, where:

service - The service providing the capability, or iotsitewise.
capability - The specific capability type. Options include: opcuacollector for the OPC UA data source collector, or publisher for data publisher capability.
version - The version number of the capability. Option include 2 for Classic streams, V2 gateways, and 3 for MQTT-enabled, V3 gateways.

After updating a capability configuration, the sync status becomes OUT_OF_SYNC until the gateway processes the configuration.Use DescribeGatewayCapabilityConfiguration to check the sync status and verify the configuration was applied.

A gateway can have multiple capability configurations with different namespaces.

Request Syntax


GET /20200301/gateways/gatewayId/capability/capabilityNamespace HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

capabilityNamespace

The namespace of the capability configuration. For example, if you configure OPC UA sources for an MQTT-enabled gateway, your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:3.

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: ^[a-zA-Z]+:[a-zA-Z]+:[0-9]+$

Required: Yes

gatewayId

The ID of the gateway that defines the capability configuration.

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

{
   "capabilityConfiguration": "string",
   "capabilityNamespace": "string",
   "capabilitySyncStatus": "string",
   "gatewayId": "string"
}

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.

capabilityConfiguration

The JSON document that defines the gateway capability's configuration. For more information, see Configuring data sources (CLI) in the Amazon IoT SiteWise User Guide.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 10000000.

capabilityNamespace

The namespace of the gateway capability.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: ^[a-zA-Z]+:[a-zA-Z]+:[0-9]+$

capabilitySyncStatus

The synchronization status of the gateway capability configuration. The sync status can be one of the following:

IN_SYNC - The gateway is running with the latest configuration.
OUT_OF_SYNC - The gateway hasn't received the latest configuration.
SYNC_FAILED - The gateway rejected the latest configuration.
UNKNOWN - The gateway hasn't reported its sync status.
NOT_APPLICABLE - The gateway doesn't support this capability. This is most common when integrating partner data sources, because the data integration is handled externally by the partner.

Type: String

Valid Values: IN_SYNC | OUT_OF_SYNC | SYNC_FAILED | UNKNOWN | NOT_APPLICABLE

gatewayId

The ID of the gateway that defines the capability configuration.

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}$

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalFailureException

Amazon 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 Amazon 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 Amazon IoT SiteWise User Guide.

HTTP Status Code: 429