aws_sdk_iotsitewise/client/
describe_gateway.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`DescribeGateway`](crate::operation::describe_gateway::builders::DescribeGatewayFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`gateway_id(impl Into<String>)`](crate::operation::describe_gateway::builders::DescribeGatewayFluentBuilder::gateway_id) / [`set_gateway_id(Option<String>)`](crate::operation::describe_gateway::builders::DescribeGatewayFluentBuilder::set_gateway_id):<br>required: **true**<br><p>The ID of the gateway device.</p><br>
7    /// - On success, responds with [`DescribeGatewayOutput`](crate::operation::describe_gateway::DescribeGatewayOutput) with field(s):
8    ///   - [`gateway_id(String)`](crate::operation::describe_gateway::DescribeGatewayOutput::gateway_id): <p>The ID of the gateway device.</p>
9    ///   - [`gateway_name(String)`](crate::operation::describe_gateway::DescribeGatewayOutput::gateway_name): <p>The name of the gateway.</p>
10    ///   - [`gateway_arn(String)`](crate::operation::describe_gateway::DescribeGatewayOutput::gateway_arn): <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the gateway, which has the following format.</p> <p><code>arn:${Partition}:iotsitewise:${Region}:${Account}:gateway/${GatewayId}</code></p>
11    ///   - [`gateway_platform(Option<GatewayPlatform>)`](crate::operation::describe_gateway::DescribeGatewayOutput::gateway_platform): <p>The gateway's platform.</p>
12    ///   - [`gateway_version(Option<String>)`](crate::operation::describe_gateway::DescribeGatewayOutput::gateway_version): <p>The version of the gateway. A value of <code>3</code> indicates an MQTT-enabled, V3 gateway, while <code>2</code> indicates a Classic streams, V2 gateway.</p>
13    ///   - [`gateway_capability_summaries(Vec::<GatewayCapabilitySummary>)`](crate::operation::describe_gateway::DescribeGatewayOutput::gateway_capability_summaries): <p>A list of gateway capability summaries that each contain a namespace and status. Each gateway capability defines data sources for the gateway. To retrieve a capability configuration's definition, use <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeGatewayCapabilityConfiguration.html">DescribeGatewayCapabilityConfiguration</a>.</p>
14    ///   - [`creation_date(DateTime)`](crate::operation::describe_gateway::DescribeGatewayOutput::creation_date): <p>The date the gateway was created, in Unix epoch time.</p>
15    ///   - [`last_update_date(DateTime)`](crate::operation::describe_gateway::DescribeGatewayOutput::last_update_date): <p>The date the gateway was last updated, in Unix epoch time.</p>
16    /// - On failure, responds with [`SdkError<DescribeGatewayError>`](crate::operation::describe_gateway::DescribeGatewayError)
17    pub fn describe_gateway(&self) -> crate::operation::describe_gateway::builders::DescribeGatewayFluentBuilder {
18        crate::operation::describe_gateway::builders::DescribeGatewayFluentBuilder::new(self.handle.clone())
19    }
20}
aws_sdk_iotsitewise/client/describe_gateway.rs

aws_sdk_iotsitewise/client/
describe_gateway.rs
