Class: Aws::IoTSiteWise::Types::DescribeGatewayCapabilityConfigurationResponse

Inherits:

Struct

• Object
• Struct
• Aws::IoTSiteWise::Types::DescribeGatewayCapabilityConfigurationResponse

Includes:

Structure

Defined in:

lib/aws-sdk-iotsitewise/types.rb

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #capability_configuration ⇒ String

  The JSON document that defines the gateway capability’s configuration.

• #capability_namespace ⇒ String

  The namespace of the gateway capability.

• #capability_sync_status ⇒ String

  The synchronization status of the capability configuration.

• #gateway_id ⇒ String

  The ID of the gateway that defines the capability configuration.

Instance Attribute Details

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

[1]: docs.aws.amazon.com/iot-sitewise/latest/userguide/configure-sources.html#configure-source-cli

Returns:

• (String)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 5014

class DescribeGatewayCapabilityConfigurationResponse < Struct.new(
  :gateway_id,
  :capability_namespace,
  :capability_configuration,
  :capability_sync_status)
  SENSITIVE = []
  include Aws::Structure
end

#capability_namespace ⇒ String

The namespace of the gateway capability.

Returns:

• (String)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 5014

class DescribeGatewayCapabilityConfigurationResponse < Struct.new(
  :gateway_id,
  :capability_namespace,
  :capability_configuration,
  :capability_sync_status)
  SENSITIVE = []
  include Aws::Structure
end

#capability_sync_status ⇒ 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.

• ‘NOT_APPLICABLE` – Synchronization is not required for this capability configuration. This is most common when integrating partner data sources, because the data integration is handled externally by the partner.

• ‘OUT_OF_SYNC` – The gateway hasn’t received the capability configuration.

• ‘SYNC_FAILED` – The gateway rejected the capability configuration.

• ‘UNKNOWN` – The synchronization status is currently unknown due to an undetermined or temporary error.

Returns:

• (String)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 5014

class DescribeGatewayCapabilityConfigurationResponse < Struct.new(
  :gateway_id,
  :capability_namespace,
  :capability_configuration,
  :capability_sync_status)
  SENSITIVE = []
  include Aws::Structure
end

#gateway_id ⇒ String

The ID of the gateway that defines the capability configuration.

Returns:

• (String)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 5014

class DescribeGatewayCapabilityConfigurationResponse < Struct.new(
  :gateway_id,
  :capability_namespace,
  :capability_configuration,
  :capability_sync_status)
  SENSITIVE = []
  include Aws::Structure
end