aws_sdk_codedeploy/client/

list_deployments.rs

// 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:
    ///   - [`application_name(impl Into<String>)`](crate::operation::list_deployments::builders::ListDeploymentsFluentBuilder::application_name) / [`set_application_name(Option<String>)`](crate::operation::list_deployments::builders::ListDeploymentsFluentBuilder::set_application_name):<br>required: **false**<br><p>The name of an CodeDeploy application associated with the user or Amazon Web Services account.</p><note>  <p>If <code>applicationName</code> is specified, then <code>deploymentGroupName</code> must be specified. If it is not specified, then <code>deploymentGroupName</code> must not be specified.</p> </note><br>
    ///   - [`deployment_group_name(impl Into<String>)`](crate::operation::list_deployments::builders::ListDeploymentsFluentBuilder::deployment_group_name) / [`set_deployment_group_name(Option<String>)`](crate::operation::list_deployments::builders::ListDeploymentsFluentBuilder::set_deployment_group_name):<br>required: **false**<br><p>The name of a deployment group for the specified application.</p><note>  <p>If <code>deploymentGroupName</code> is specified, then <code>applicationName</code> must be specified. If it is not specified, then <code>applicationName</code> must not be specified.</p> </note><br>
    ///   - [`external_id(impl Into<String>)`](crate::operation::list_deployments::builders::ListDeploymentsFluentBuilder::external_id) / [`set_external_id(Option<String>)`](crate::operation::list_deployments::builders::ListDeploymentsFluentBuilder::set_external_id):<br>required: **false**<br><p>The unique ID of an external resource for returning deployments linked to the external resource.</p><br>
    ///   - [`include_only_statuses(DeploymentStatus)`](crate::operation::list_deployments::builders::ListDeploymentsFluentBuilder::include_only_statuses) / [`set_include_only_statuses(Option<Vec::<DeploymentStatus>>)`](crate::operation::list_deployments::builders::ListDeploymentsFluentBuilder::set_include_only_statuses):<br>required: **false**<br><p>A subset of deployments to list by status:</p> <ul>  <li>   <p><code>Created</code>: Include created deployments in the resulting list.</p></li>  <li>   <p><code>Queued</code>: Include queued deployments in the resulting list.</p></li>  <li>   <p><code>In Progress</code>: Include in-progress deployments in the resulting list.</p></li>  <li>   <p><code>Succeeded</code>: Include successful deployments in the resulting list.</p></li>  <li>   <p><code>Failed</code>: Include failed deployments in the resulting list.</p></li>  <li>   <p><code>Stopped</code>: Include stopped deployments in the resulting list.</p></li> </ul><br>
    ///   - [`create_time_range(TimeRange)`](crate::operation::list_deployments::builders::ListDeploymentsFluentBuilder::create_time_range) / [`set_create_time_range(Option<TimeRange>)`](crate::operation::list_deployments::builders::ListDeploymentsFluentBuilder::set_create_time_range):<br>required: **false**<br><p>A time range (start and end) for returning a subset of the list of deployments.</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>An identifier returned from the previous list deployments call. It can be used to return the next set of deployments in the list.</p><br>
    /// - On success, responds with [`ListDeploymentsOutput`](crate::operation::list_deployments::ListDeploymentsOutput) with field(s):
    ///   - [`deployments(Option<Vec::<String>>)`](crate::operation::list_deployments::ListDeploymentsOutput::deployments): <p>A list of deployment IDs.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_deployments::ListDeploymentsOutput::next_token): <p>If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list deployments call to return the next set of deployments in the list.</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())
    }
}