gateway_capability_configurations

Creates, updates, deletes, gets or lists a gateway_capability_configurations resource.

Overview

Name	`gateway_capability_configurations`
Type	Resource
Id	`aws.iotsitewise.gateway_capability_configurations`

Fields

The following fields are returned by SELECT queries:

describe_gateway_capability_configuration

Name	Datatype	Description
`capability_configuration`	`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.
`capability_namespace`	`string`	The namespace of the gateway capability. (pattern: <code>^[a-zA-Z]+:[a-zA-Z]+:[0-9]+$</code>)
`capability_sync_status`	`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. (IN_SYNC, OUT_OF_SYNC, SYNC_FAILED, UNKNOWN, NOT_APPLICABLE)
`gateway_id`	`string`	The ID of the gateway that defines the capability configuration. (pattern: <code>^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`describe_gateway_capability_configuration`	`select`	`gateway_id`, `capability_namespace`, `region`		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.
`update_gateway_capability_configuration`	`update`	`gateway_id`, `region`, `capabilityNamespace`, `capabilityConfiguration`		Updates a gateway capability configuration or defines a new capability configuration. Each gateway capability defines data sources for a gateway. Important workflow notes: 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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`capability_namespace`	`string`	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.
`gateway_id`	`string`	The ID of the gateway to be updated.
`region`	`string`	AWS region (default: us-east-1)

`SELECT` examples

describe_gateway_capability_configuration

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.

SELECT
capability_configuration,
capability_namespace,
capability_sync_status,
gateway_id
FROM aws.iotsitewise.gateway_capability_configurations
WHERE gateway_id = '{{ gateway_id }}' -- required
AND capability_namespace = '{{ capability_namespace }}' -- required
AND region = '{{ region }}' -- required
;

`UPDATE` examples

update_gateway_capability_configuration

Updates a gateway capability configuration or defines a new capability configuration. Each gateway capability defines data sources for a gateway. Important workflow notes: 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.

UPDATE aws.iotsitewise.gateway_capability_configurations
SET 
capabilityNamespace = '{{ capabilityNamespace }}',
capabilityConfiguration = '{{ capabilityConfiguration }}'
WHERE 
gateway_id = '{{ gateway_id }}' --required
AND region = '{{ region }}' --required
AND capabilityNamespace = '{{ capabilityNamespace }}' --required
AND capabilityConfiguration = '{{ capabilityConfiguration }}' --required
RETURNING
capability_namespace,
capability_sync_status;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

UPDATE examples​