aws_sdk_ecs/client/

describe_clusters.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeClusters`](crate::operation::describe_clusters::builders::DescribeClustersFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`clusters(impl Into<String>)`](crate::operation::describe_clusters::builders::DescribeClustersFluentBuilder::clusters) / [`set_clusters(Option<Vec::<String>>)`](crate::operation::describe_clusters::builders::DescribeClustersFluentBuilder::set_clusters):<br>required: **false**<br><p>A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries. If you do not specify a cluster, the default cluster is assumed.</p><br>
    ///   - [`include(ClusterField)`](crate::operation::describe_clusters::builders::DescribeClustersFluentBuilder::include) / [`set_include(Option<Vec::<ClusterField>>)`](crate::operation::describe_clusters::builders::DescribeClustersFluentBuilder::set_include):<br>required: **false**<br><p>Determines whether to include additional information about the clusters in the response. If this field is omitted, this information isn't included.</p> <p>If <code>ATTACHMENTS</code> is specified, the attachments for the container instances or tasks within the cluster are included, for example the capacity providers.</p> <p>If <code>SETTINGS</code> is specified, the settings for the cluster are included.</p> <p>If <code>CONFIGURATIONS</code> is specified, the configuration for the cluster is included.</p> <p>If <code>STATISTICS</code> is specified, the task and service count is included, separated by launch type.</p> <p>If <code>TAGS</code> is specified, the metadata tags associated with the cluster are included.</p><br>
    /// - On success, responds with [`DescribeClustersOutput`](crate::operation::describe_clusters::DescribeClustersOutput) with field(s):
    ///   - [`clusters(Option<Vec::<Cluster>>)`](crate::operation::describe_clusters::DescribeClustersOutput::clusters): <p>The list of clusters.</p>
    ///   - [`failures(Option<Vec::<Failure>>)`](crate::operation::describe_clusters::DescribeClustersOutput::failures): <p>Any failures associated with the call.</p>
    /// - On failure, responds with [`SdkError<DescribeClustersError>`](crate::operation::describe_clusters::DescribeClustersError)
    pub fn describe_clusters(&self) -> crate::operation::describe_clusters::builders::DescribeClustersFluentBuilder {
        crate::operation::describe_clusters::builders::DescribeClustersFluentBuilder::new(self.handle.clone())
    }
}