aws_sdk_launchwizard/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    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_deployments::builders::ListDeploymentsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`filters(DeploymentFilter)`](crate::operation::list_deployments::builders::ListDeploymentsFluentBuilder::filters) / [`set_filters(Option<Vec::<DeploymentFilter>>)`](crate::operation::list_deployments::builders::ListDeploymentsFluentBuilder::set_filters):<br>required: **false**<br><p>Filters to scope the results. The following filters are supported:</p> <ul>  <li>   <p><code>WORKLOAD_NAME</code> - The name used in deployments.</p></li>  <li>   <p><code>DEPLOYMENT_STATUS</code> - <code>COMPLETED</code> | <code>CREATING</code> | <code>DELETE_IN_PROGRESS</code> | <code>DELETE_INITIATING</code> | <code>DELETE_FAILED</code> | <code>DELETED</code> | <code>FAILED</code> | <code>IN_PROGRESS</code> | <code>VALIDATING</code></p></li> </ul><br>
8    ///   - [`max_results(i32)`](crate::operation::list_deployments::builders::ListDeploymentsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_deployments::builders::ListDeploymentsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.</p><br>
9    ///   - [`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><p>The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.</p><br>
10    /// - On success, responds with [`ListDeploymentsOutput`](crate::operation::list_deployments::ListDeploymentsOutput) with field(s):
11    ///   - [`deployments(Option<Vec::<DeploymentDataSummary>>)`](crate::operation::list_deployments::ListDeploymentsOutput::deployments): <p>Lists the deployments.</p>
12    ///   - [`next_token(Option<String>)`](crate::operation::list_deployments::ListDeploymentsOutput::next_token): <p>The token to include in another request to get the next page of items. This value is <code>null</code> when there are no more items to return.</p>
13    /// - On failure, responds with [`SdkError<ListDeploymentsError>`](crate::operation::list_deployments::ListDeploymentsError)
14    pub fn list_deployments(&self) -> crate::operation::list_deployments::builders::ListDeploymentsFluentBuilder {
15        crate::operation::list_deployments::builders::ListDeploymentsFluentBuilder::new(self.handle.clone())
16    }
17}