IoTSiteWise / Client / describe_gateway_capability_configuration

describe_gateway_capability_configuration#

IoTSiteWise.Client.describe_gateway_capability_configuration(**kwargs)#

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 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.

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

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 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.

Exceptions