aws_sdk_iotsitewise/client/

describe_gateway_capability_configuration.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeGatewayCapabilityConfiguration`](crate::operation::describe_gateway_capability_configuration::builders::DescribeGatewayCapabilityConfigurationFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`gateway_id(impl Into<String>)`](crate::operation::describe_gateway_capability_configuration::builders::DescribeGatewayCapabilityConfigurationFluentBuilder::gateway_id) / [`set_gateway_id(Option<String>)`](crate::operation::describe_gateway_capability_configuration::builders::DescribeGatewayCapabilityConfigurationFluentBuilder::set_gateway_id):<br>required: **true**<br><p>The ID of the gateway that defines the capability configuration.</p><br>
    ///   - [`capability_namespace(impl Into<String>)`](crate::operation::describe_gateway_capability_configuration::builders::DescribeGatewayCapabilityConfigurationFluentBuilder::capability_namespace) / [`set_capability_namespace(Option<String>)`](crate::operation::describe_gateway_capability_configuration::builders::DescribeGatewayCapabilityConfigurationFluentBuilder::set_capability_namespace):<br>required: **true**<br><p>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 <code>iotsitewise:opcuacollector:3</code>.</p><br>
    /// - On success, responds with [`DescribeGatewayCapabilityConfigurationOutput`](crate::operation::describe_gateway_capability_configuration::DescribeGatewayCapabilityConfigurationOutput) with field(s):
    ///   - [`gateway_id(String)`](crate::operation::describe_gateway_capability_configuration::DescribeGatewayCapabilityConfigurationOutput::gateway_id): <p>The ID of the gateway that defines the capability configuration.</p>
    ///   - [`capability_namespace(String)`](crate::operation::describe_gateway_capability_configuration::DescribeGatewayCapabilityConfigurationOutput::capability_namespace): <p>The namespace of the gateway capability.</p>
    ///   - [`capability_configuration(String)`](crate::operation::describe_gateway_capability_configuration::DescribeGatewayCapabilityConfigurationOutput::capability_configuration): <p>The JSON document that defines the gateway capability's configuration. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/configure-sources.html#configure-source-cli">Configuring data sources (CLI)</a> in the <i>IoT SiteWise User Guide</i>.</p>
    ///   - [`capability_sync_status(CapabilitySyncStatus)`](crate::operation::describe_gateway_capability_configuration::DescribeGatewayCapabilityConfigurationOutput::capability_sync_status): <p>The synchronization status of the gateway capability configuration. The sync status can be one of the following:</p> <ul>  <li>   <p><code>IN_SYNC</code> - The gateway is running with the latest configuration.</p></li>  <li>   <p><code>OUT_OF_SYNC</code> - The gateway hasn't received the latest configuration.</p></li>  <li>   <p><code>SYNC_FAILED</code> - The gateway rejected the latest configuration.</p></li>  <li>   <p><code>UNKNOWN</code> - The gateway hasn't reported its sync status.</p></li>  <li>   <p><code>NOT_APPLICABLE</code> - 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.</p></li> </ul>
    /// - On failure, responds with [`SdkError<DescribeGatewayCapabilityConfigurationError>`](crate::operation::describe_gateway_capability_configuration::DescribeGatewayCapabilityConfigurationError)
    pub fn describe_gateway_capability_configuration(
        &self,
    ) -> crate::operation::describe_gateway_capability_configuration::builders::DescribeGatewayCapabilityConfigurationFluentBuilder {
        crate::operation::describe_gateway_capability_configuration::builders::DescribeGatewayCapabilityConfigurationFluentBuilder::new(
            self.handle.clone(),
        )
    }
}