aws_sdk_ecs/client/

list_attributes.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListAttributes`](crate::operation::list_attributes::builders::ListAttributesFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_attributes::builders::ListAttributesFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`cluster(impl Into<String>)`](crate::operation::list_attributes::builders::ListAttributesFluentBuilder::cluster) / [`set_cluster(Option<String>)`](crate::operation::list_attributes::builders::ListAttributesFluentBuilder::set_cluster):<br>required: **false**<br><p>The short name or full Amazon Resource Name (ARN) of the cluster to list attributes. If you do not specify a cluster, the default cluster is assumed.</p><br>
    ///   - [`target_type(TargetType)`](crate::operation::list_attributes::builders::ListAttributesFluentBuilder::target_type) / [`set_target_type(Option<TargetType>)`](crate::operation::list_attributes::builders::ListAttributesFluentBuilder::set_target_type):<br>required: **true**<br><p>The type of the target to list attributes with.</p><br>
    ///   - [`attribute_name(impl Into<String>)`](crate::operation::list_attributes::builders::ListAttributesFluentBuilder::attribute_name) / [`set_attribute_name(Option<String>)`](crate::operation::list_attributes::builders::ListAttributesFluentBuilder::set_attribute_name):<br>required: **false**<br><p>The name of the attribute to filter the results with.</p><br>
    ///   - [`attribute_value(impl Into<String>)`](crate::operation::list_attributes::builders::ListAttributesFluentBuilder::attribute_value) / [`set_attribute_value(Option<String>)`](crate::operation::list_attributes::builders::ListAttributesFluentBuilder::set_attribute_value):<br>required: **false**<br><p>The value of the attribute to filter results with. You must also specify an attribute name to use this parameter.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_attributes::builders::ListAttributesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_attributes::builders::ListAttributesFluentBuilder::set_next_token):<br>required: **false**<br><p>The <code>nextToken</code> value returned from a <code>ListAttributes</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_attributes::builders::ListAttributesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_attributes::builders::ListAttributesFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of cluster results that <code>ListAttributes</code> returned in paginated output. When this parameter is used, <code>ListAttributes</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>ListAttributes</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>ListAttributes</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</p><br>
    /// - On success, responds with [`ListAttributesOutput`](crate::operation::list_attributes::ListAttributesOutput) with field(s):
    ///   - [`attributes(Option<Vec::<Attribute>>)`](crate::operation::list_attributes::ListAttributesOutput::attributes): <p>A list of attribute objects that meet the criteria of the request.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_attributes::ListAttributesOutput::next_token): <p>The <code>nextToken</code> value to include in a future <code>ListAttributes</code> request. When the results of a <code>ListAttributes</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<ListAttributesError>`](crate::operation::list_attributes::ListAttributesError)
    pub fn list_attributes(&self) -> crate::operation::list_attributes::builders::ListAttributesFluentBuilder {
        crate::operation::list_attributes::builders::ListAttributesFluentBuilder::new(self.handle.clone())
    }
}