DescribeGatewayCapabilityConfiguration - AWS IoT SiteWise

DescribeGatewayCapabilityConfiguration

Retrieves information about a gateway capability configuration. Each gateway capability defines data sources for a gateway. A capability configuration can contain multiple data source configurations. If you define OPC-UA sources for a gateway in the AWS IoT SiteWise console, all of your OPC-UA sources are stored in one capability configuration. To list all capability configurations for a gateway, use DescribeGateway.

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 from the AWS IoT SiteWise console, your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:version, where version is a number such as 1.

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

Type: String

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

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 capability configuration. The sync status can be one of the following:

  • IN_SYNC – The gateway is running the capability configuration.

  • OUT_OF_SYNC – The gateway hasn't received the capability configuration.

  • SYNC_FAILED – The gateway rejected the capability configuration.

Type: String

Valid Values: IN_SYNC | OUT_OF_SYNC | SYNC_FAILED

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

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: