aws-sdk-greengrassv2 1.112.0

AWS SDK for AWS IoT Greengrass V2
Documentation
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListDeployments`](crate::operation::list_deployments::builders::ListDeploymentsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_deployments::builders::ListDeploymentsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`target_arn(impl Into<String>)`](crate::operation::list_deployments::builders::ListDeploymentsFluentBuilder::target_arn) / [`set_target_arn(Option<String>)`](crate::operation::list_deployments::builders::ListDeploymentsFluentBuilder::set_target_arn):<br>required: **false**<br><p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the target IoT thing or thing group.</p><br>
    ///   - [`history_filter(DeploymentHistoryFilter)`](crate::operation::list_deployments::builders::ListDeploymentsFluentBuilder::history_filter) / [`set_history_filter(Option<DeploymentHistoryFilter>)`](crate::operation::list_deployments::builders::ListDeploymentsFluentBuilder::set_history_filter):<br>required: **false**<br><p>The filter for the list of deployments. Choose one of the following options:</p> <ul>  <li>   <p><code>ALL</code> – The list includes all deployments.</p></li>  <li>   <p><code>LATEST_ONLY</code> – The list includes only the latest revision of each deployment.</p></li> </ul> <p>Default: <code>LATEST_ONLY</code></p><br>
    ///   - [`parent_target_arn(impl Into<String>)`](crate::operation::list_deployments::builders::ListDeploymentsFluentBuilder::parent_target_arn) / [`set_parent_target_arn(Option<String>)`](crate::operation::list_deployments::builders::ListDeploymentsFluentBuilder::set_parent_target_arn):<br>required: **false**<br><p>The parent deployment's target <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> within a subdeployment.</p><br>
    ///   - [`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 results to be returned per paginated request.</p> <p>Default: <code>50</code></p><br>
    ///   - [`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 to be used for the next set of paginated results.</p><br>
    /// - On success, responds with [`ListDeploymentsOutput`](crate::operation::list_deployments::ListDeploymentsOutput) with field(s):
    ///   - [`deployments(Option<Vec::<Deployment>>)`](crate::operation::list_deployments::ListDeploymentsOutput::deployments): <p>A list that summarizes each deployment.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_deployments::ListDeploymentsOutput::next_token): <p>The token for the next set of results, or null if there are no additional results.</p>
    /// - On failure, responds with [`SdkError<ListDeploymentsError>`](crate::operation::list_deployments::ListDeploymentsError)
    pub fn list_deployments(&self) -> crate::operation::list_deployments::builders::ListDeploymentsFluentBuilder {
        crate::operation::list_deployments::builders::ListDeploymentsFluentBuilder::new(self.handle.clone())
    }
}