aws_sdk_ecs/client/

list_container_instances.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListContainerInstances`](crate::operation::list_container_instances::builders::ListContainerInstancesFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_container_instances::builders::ListContainerInstancesFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`cluster(impl Into<String>)`](crate::operation::list_container_instances::builders::ListContainerInstancesFluentBuilder::cluster) / [`set_cluster(Option<String>)`](crate::operation::list_container_instances::builders::ListContainerInstancesFluentBuilder::set_cluster):<br>required: **false**<br><p>The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to list. If you do not specify a cluster, the default cluster is assumed.</p><br>
    ///   - [`filter(impl Into<String>)`](crate::operation::list_container_instances::builders::ListContainerInstancesFluentBuilder::filter) / [`set_filter(Option<String>)`](crate::operation::list_container_instances::builders::ListContainerInstancesFluentBuilder::set_filter):<br>required: **false**<br><p>You can filter the results of a <code>ListContainerInstances</code> operation with cluster query language statements. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html">Cluster Query Language</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_container_instances::builders::ListContainerInstancesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_container_instances::builders::ListContainerInstancesFluentBuilder::set_next_token):<br>required: **false**<br><p>The <code>nextToken</code> value returned from a <code>ListContainerInstances</code> request indicating that more results are available to fulfill the request and further calls are needed. If <code>maxResults</code> was provided, it's possible the number of results to be fewer than <code>maxResults</code>.</p><note>  <p>This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.</p> </note><br>
    ///   - [`max_results(i32)`](crate::operation::list_container_instances::builders::ListContainerInstancesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_container_instances::builders::ListContainerInstancesFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of container instance results that <code>ListContainerInstances</code> returned in paginated output. When this parameter is used, <code>ListContainerInstances</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>ListContainerInstances</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>ListContainerInstances</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</p><br>
    ///   - [`status(ContainerInstanceStatus)`](crate::operation::list_container_instances::builders::ListContainerInstancesFluentBuilder::status) / [`set_status(Option<ContainerInstanceStatus>)`](crate::operation::list_container_instances::builders::ListContainerInstancesFluentBuilder::set_status):<br>required: **false**<br><p>Filters the container instances by status. For example, if you specify the <code>DRAINING</code> status, the results include only container instances that have been set to <code>DRAINING</code> using <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateContainerInstancesState.html">UpdateContainerInstancesState</a>. If you don't specify this parameter, the default is to include container instances set to all states other than <code>INACTIVE</code>.</p><br>
    /// - On success, responds with [`ListContainerInstancesOutput`](crate::operation::list_container_instances::ListContainerInstancesOutput) with field(s):
    ///   - [`container_instance_arns(Option<Vec::<String>>)`](crate::operation::list_container_instances::ListContainerInstancesOutput::container_instance_arns): <p>The list of container instances with full ARN entries for each container instance associated with the specified cluster.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_container_instances::ListContainerInstancesOutput::next_token): <p>The <code>nextToken</code> value to include in a future <code>ListContainerInstances</code> request. When the results of a <code>ListContainerInstances</code> request exceed <code>maxResults</code>, this value can be used to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>
    /// - On failure, responds with [`SdkError<ListContainerInstancesError>`](crate::operation::list_container_instances::ListContainerInstancesError)
    pub fn list_container_instances(&self) -> crate::operation::list_container_instances::builders::ListContainerInstancesFluentBuilder {
        crate::operation::list_container_instances::builders::ListContainerInstancesFluentBuilder::new(self.handle.clone())
    }
}