IoTSiteWise / Client / describe_gateway_capability_configuration

describe_gateway_capability_configuration

IoTSiteWise.Client.describe_gateway_capability_configuration(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_gateway_capability_configuration(
    gatewayId='string',
    capabilityNamespace='string'
)
Parameters:

  • gatewayId (string) –

    [REQUIRED]

    The ID of the gateway that defines the capability configuration.

  • capabilityNamespace (string) –

    [REQUIRED]

    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.

Return type:

dict

Returns:

Response Syntax

{
    'gatewayId': 'string',
    'capabilityNamespace': 'string',
    'capabilityConfiguration': 'string',
    'capabilitySyncStatus': 'IN_SYNC'|'OUT_OF_SYNC'|'SYNC_FAILED'|'UNKNOWN'|'NOT_APPLICABLE'
}

Response Structure

  • (dict) –

    • gatewayId (string) –

      The ID of the gateway that defines the capability configuration.

    • capabilityNamespace (string) –

      The namespace of the gateway capability.

    • capabilityConfiguration (string) –

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

    • capabilitySyncStatus (string) –

      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.

Exceptions

  • IoTSiteWise.Client.exceptions.InvalidRequestException

  • IoTSiteWise.Client.exceptions.ResourceNotFoundException

  • IoTSiteWise.Client.exceptions.InternalFailureException

  • IoTSiteWise.Client.exceptions.ThrottlingException