DescribeGatewayCapabilityConfigurationRequest Class

Container for the parameters to the DescribeGatewayCapabilityConfiguration operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.IoTSiteWise.AmazonIoTSiteWiseRequest
      Amazon.IoTSiteWise.Model.DescribeGatewayCapabilityConfigurationRequest

Namespace: Amazon.IoTSiteWise.Model
Assembly: AWSSDK.IoTSiteWise.dll
Version: 3.x.y.z

Syntax

public class DescribeGatewayCapabilityConfigurationRequest : AmazonIoTSiteWiseRequest
         IAmazonWebServiceRequest

The DescribeGatewayCapabilityConfigurationRequest type exposes the following members

Constructors

	Name	Description
	DescribeGatewayCapabilityConfigurationRequest()

Properties

Name Type Description

	Name	Type	Description
	CapabilityNamespace	System.String	Gets and sets the property 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`.
	GatewayId	System.String	Gets and sets the property GatewayId. The ID of the gateway that defines the capability configuration.

CapabilityNamespace

System.String

Gets and sets the property 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.

GatewayId

System.String

Gets and sets the property GatewayId.

The ID of the gateway that defines the capability configuration.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5