aws_sdk_ecs/client/

list_service_deployments.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListServiceDeployments`](crate::operation::list_service_deployments::builders::ListServiceDeploymentsFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`service(impl Into<String>)`](crate::operation::list_service_deployments::builders::ListServiceDeploymentsFluentBuilder::service) / [`set_service(Option<String>)`](crate::operation::list_service_deployments::builders::ListServiceDeploymentsFluentBuilder::set_service):<br>required: **true**<br><p>The ARN or name of the service</p><br>
    ///   - [`cluster(impl Into<String>)`](crate::operation::list_service_deployments::builders::ListServiceDeploymentsFluentBuilder::cluster) / [`set_cluster(Option<String>)`](crate::operation::list_service_deployments::builders::ListServiceDeploymentsFluentBuilder::set_cluster):<br>required: **false**<br><p>The cluster that hosts the service. This can either be the cluster name or ARN. Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. If you don't specify a cluster, <code>default</code> is used.</p><br>
    ///   - [`status(ServiceDeploymentStatus)`](crate::operation::list_service_deployments::builders::ListServiceDeploymentsFluentBuilder::status) / [`set_status(Option<Vec::<ServiceDeploymentStatus>>)`](crate::operation::list_service_deployments::builders::ListServiceDeploymentsFluentBuilder::set_status):<br>required: **false**<br><p>An optional filter you can use to narrow the results. If you do not specify a status, then all status values are included in the result.</p><br>
    ///   - [`created_at(CreatedAt)`](crate::operation::list_service_deployments::builders::ListServiceDeploymentsFluentBuilder::created_at) / [`set_created_at(Option<CreatedAt>)`](crate::operation::list_service_deployments::builders::ListServiceDeploymentsFluentBuilder::set_created_at):<br>required: **false**<br><p>An optional filter you can use to narrow the results by the service creation date. If you do not specify a value, the result includes all services created before the current time. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_service_deployments::builders::ListServiceDeploymentsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_service_deployments::builders::ListServiceDeploymentsFluentBuilder::set_next_token):<br>required: **false**<br><p>The <code>nextToken</code> value returned from a <code>ListServiceDeployments</code> request indicating that more results are available to fulfill the request and further calls are needed. If you provided <code>maxResults</code>, it's possible the number of results is fewer than <code>maxResults</code>.</p><br>
    ///   - [`max_results(i32)`](crate::operation::list_service_deployments::builders::ListServiceDeploymentsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_service_deployments::builders::ListServiceDeploymentsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of service deployment results that <code>ListServiceDeployments</code> returned in paginated output. When this parameter is used, <code>ListServiceDeployments</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>ListServiceDeployments</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter isn't used, then <code>ListServiceDeployments</code> returns up to 20 results and a <code>nextToken</code> value if applicable.</p><br>
    /// - On success, responds with [`ListServiceDeploymentsOutput`](crate::operation::list_service_deployments::ListServiceDeploymentsOutput) with field(s):
    ///   - [`service_deployments(Option<Vec::<ServiceDeploymentBrief>>)`](crate::operation::list_service_deployments::ListServiceDeploymentsOutput::service_deployments): <p>An overview of the service deployment, including the following properties:</p> <ul>  <li>   <p>The ARN of the service deployment.</p></li>  <li>   <p>The ARN of the service being deployed.</p></li>  <li>   <p>The ARN of the cluster that hosts the service in the service deployment.</p></li>  <li>   <p>The time that the service deployment started.</p></li>  <li>   <p>The time that the service deployment completed.</p></li>  <li>   <p>The service deployment status.</p></li>  <li>   <p>Information about why the service deployment is in the current state.</p></li>  <li>   <p>The ARN of the service revision that is being deployed.</p></li> </ul>
    ///   - [`next_token(Option<String>)`](crate::operation::list_service_deployments::ListServiceDeploymentsOutput::next_token): <p>The <code>nextToken</code> value to include in a future <code>ListServiceDeployments</code> request. When the results of a <code>ListServiceDeployments</code> request exceed <code>maxResults</code>, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.</p>
    /// - On failure, responds with [`SdkError<ListServiceDeploymentsError>`](crate::operation::list_service_deployments::ListServiceDeploymentsError)
    pub fn list_service_deployments(&self) -> crate::operation::list_service_deployments::builders::ListServiceDeploymentsFluentBuilder {
        crate::operation::list_service_deployments::builders::ListServiceDeploymentsFluentBuilder::new(self.handle.clone())
    }
}