aws_sdk_greengrass/client/
list_deployments.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 [`ListDeployments`](crate::operation::list_deployments::builders::ListDeploymentsFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`group_id(impl Into<String>)`](crate::operation::list_deployments::builders::ListDeploymentsFluentBuilder::group_id) / [`set_group_id(Option<String>)`](crate::operation::list_deployments::builders::ListDeploymentsFluentBuilder::set_group_id):<br>required: **true**<br>The ID of the Greengrass group.<br>
7    ///   - [`max_results(impl Into<String>)`](crate::operation::list_deployments::builders::ListDeploymentsFluentBuilder::max_results) / [`set_max_results(Option<String>)`](crate::operation::list_deployments::builders::ListDeploymentsFluentBuilder::set_max_results):<br>required: **false**<br>The maximum number of results to be returned per request.<br>
8    ///   - [`next_token(impl Into<String>)`](crate::operation::list_deployments::builders::ListDeploymentsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_deployments::builders::ListDeploymentsFluentBuilder::set_next_token):<br>required: **false**<br>The token for the next set of results, or ''null'' if there are no additional results.<br>
9    /// - On success, responds with [`ListDeploymentsOutput`](crate::operation::list_deployments::ListDeploymentsOutput) with field(s):
10    ///   - [`deployments(Option<Vec::<Deployment>>)`](crate::operation::list_deployments::ListDeploymentsOutput::deployments): A list of deployments for the requested groups.
11    ///   - [`next_token(Option<String>)`](crate::operation::list_deployments::ListDeploymentsOutput::next_token): The token for the next set of results, or ''null'' if there are no additional results.
12    /// - On failure, responds with [`SdkError<ListDeploymentsError>`](crate::operation::list_deployments::ListDeploymentsError)
13    pub fn list_deployments(&self) -> crate::operation::list_deployments::builders::ListDeploymentsFluentBuilder {
14        crate::operation::list_deployments::builders::ListDeploymentsFluentBuilder::new(self.handle.clone())
15    }
16}