aws_sdk_iotdataplane/client/
list_subscriptions.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 [`ListSubscriptions`](crate::operation::list_subscriptions::builders::ListSubscriptionsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_subscriptions::builders::ListSubscriptionsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`client_id(impl Into<String>)`](crate::operation::list_subscriptions::builders::ListSubscriptionsFluentBuilder::client_id) / [`set_client_id(Option<String>)`](crate::operation::list_subscriptions::builders::ListSubscriptionsFluentBuilder::set_client_id):<br>required: **true**<br><p>The unique identifier of the MQTT client to list subscriptions for. The client ID can't start with a dollar sign ($).</p> <p>MQTT client IDs must be URL encoded (percent-encoded) when they contain characters that are not valid in HTTP requests, such as spaces, forward slashes (/), and UTF-8 characters.</p><br>
8    ///   - [`next_token(impl Into<String>)`](crate::operation::list_subscriptions::builders::ListSubscriptionsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_subscriptions::builders::ListSubscriptionsFluentBuilder::set_next_token):<br>required: **false**<br><p>To retrieve the next set of results, the <code>nextToken</code> value from a previous response; otherwise <b>null</b> to receive the first set of results.</p><br>
9    ///   - [`max_results(i32)`](crate::operation::list_subscriptions::builders::ListSubscriptionsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_subscriptions::builders::ListSubscriptionsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of subscriptions to return in a single request. By default, this is set to 20.</p><br>
10    /// - On success, responds with [`ListSubscriptionsOutput`](crate::operation::list_subscriptions::ListSubscriptionsOutput) with field(s):
11    ///   - [`subscriptions(Option<Vec::<SubscriptionSummary>>)`](crate::operation::list_subscriptions::ListSubscriptionsOutput::subscriptions): <p>A list of topic filters and their associated Quality of Service (QoS) levels that the client is subscribed to.</p>
12    ///   - [`next_token(Option<String>)`](crate::operation::list_subscriptions::ListSubscriptionsOutput::next_token): <p>The token to use to get the next set of results, or <b>null</b> if there are no additional results.</p>
13    /// - On failure, responds with [`SdkError<ListSubscriptionsError>`](crate::operation::list_subscriptions::ListSubscriptionsError)
14    pub fn list_subscriptions(&self) -> crate::operation::list_subscriptions::builders::ListSubscriptionsFluentBuilder {
15        crate::operation::list_subscriptions::builders::ListSubscriptionsFluentBuilder::new(self.handle.clone())
16    }
17}
aws_sdk_iotdataplane/client/list_subscriptions.rs

aws_sdk_iotdataplane/client/
list_subscriptions.rs
