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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#capability_configurationString

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

Returns:

  • (String)


5821
5822
5823
5824
5825
5826
5827
5828
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 5821

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

#capability_namespaceString

The namespace of the gateway capability.

Returns:

  • (String)


5821
5822
5823
5824
5825
5826
5827
5828
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 5821

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

#capability_sync_statusString

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.

Returns:

  • (String)


5821
5822
5823
5824
5825
5826
5827
5828
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 5821

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

#gateway_idString

The ID of the gateway that defines the capability configuration.

Returns:

  • (String)


5821
5822
5823
5824
5825
5826
5827
5828
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 5821

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