aws_sdk_batch/client/

describe_service_environments.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeServiceEnvironments`](crate::operation::describe_service_environments::builders::DescribeServiceEnvironmentsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_service_environments::builders::DescribeServiceEnvironmentsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`service_environments(impl Into<String>)`](crate::operation::describe_service_environments::builders::DescribeServiceEnvironmentsFluentBuilder::service_environments) / [`set_service_environments(Option<Vec::<String>>)`](crate::operation::describe_service_environments::builders::DescribeServiceEnvironmentsFluentBuilder::set_service_environments):<br>required: **false**<br><p>An array of service environment names or ARN entries.</p><br>
    ///   - [`max_results(i32)`](crate::operation::describe_service_environments::builders::DescribeServiceEnvironmentsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_service_environments::builders::DescribeServiceEnvironmentsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results returned by <code>DescribeServiceEnvironments</code> in paginated output. When this parameter is used, <code>DescribeServiceEnvironments</code> only returns <code>maxResults</code> results in a single page and a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>DescribeServiceEnvironments</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>DescribeServiceEnvironments</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::describe_service_environments::builders::DescribeServiceEnvironmentsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_service_environments::builders::DescribeServiceEnvironmentsFluentBuilder::set_next_token):<br>required: **false**<br><p>The <code>nextToken</code> value returned from a previous paginated <code>DescribeServiceEnvironments</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. This value is <code>null</code> when there are no more results to return.</p><note>  <p>Treat this token as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.</p> </note><br>
    /// - On success, responds with [`DescribeServiceEnvironmentsOutput`](crate::operation::describe_service_environments::DescribeServiceEnvironmentsOutput) with field(s):
    ///   - [`service_environments(Option<Vec::<ServiceEnvironmentDetail>>)`](crate::operation::describe_service_environments::DescribeServiceEnvironmentsOutput::service_environments): <p>The list of service environments that match the request.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::describe_service_environments::DescribeServiceEnvironmentsOutput::next_token): <p>The <code>nextToken</code> value to include in a future <code>DescribeServiceEnvironments</code> request. When the results of a <code>DescribeServiceEnvironments</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<DescribeServiceEnvironmentsError>`](crate::operation::describe_service_environments::DescribeServiceEnvironmentsError)
    pub fn describe_service_environments(
        &self,
    ) -> crate::operation::describe_service_environments::builders::DescribeServiceEnvironmentsFluentBuilder {
        crate::operation::describe_service_environments::builders::DescribeServiceEnvironmentsFluentBuilder::new(self.handle.clone())
    }
}