aws_sdk_opensearch/client/
list_domain_maintenances.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`ListDomainMaintenances`](crate::operation::list_domain_maintenances::builders::ListDomainMaintenancesFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_domain_maintenances::builders::ListDomainMaintenancesFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`domain_name(impl Into<String>)`](crate::operation::list_domain_maintenances::builders::ListDomainMaintenancesFluentBuilder::domain_name) / [`set_domain_name(Option<String>)`](crate::operation::list_domain_maintenances::builders::ListDomainMaintenancesFluentBuilder::set_domain_name):<br>required: **true**<br><p>The name of the domain.</p><br>
8    ///   - [`action(MaintenanceType)`](crate::operation::list_domain_maintenances::builders::ListDomainMaintenancesFluentBuilder::action) / [`set_action(Option<MaintenanceType>)`](crate::operation::list_domain_maintenances::builders::ListDomainMaintenancesFluentBuilder::set_action):<br>required: **false**<br><p>The name of the action.</p><br>
9    ///   - [`status(MaintenanceStatus)`](crate::operation::list_domain_maintenances::builders::ListDomainMaintenancesFluentBuilder::status) / [`set_status(Option<MaintenanceStatus>)`](crate::operation::list_domain_maintenances::builders::ListDomainMaintenancesFluentBuilder::set_status):<br>required: **false**<br><p>The status of the action.</p><br>
10    ///   - [`max_results(i32)`](crate::operation::list_domain_maintenances::builders::ListDomainMaintenancesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_domain_maintenances::builders::ListDomainMaintenancesFluentBuilder::set_max_results):<br>required: **false**<br><p>An optional parameter that specifies the maximum number of results to return. You can use <code>nextToken</code> to get the next page of results.</p><br>
11    ///   - [`next_token(impl Into<String>)`](crate::operation::list_domain_maintenances::builders::ListDomainMaintenancesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_domain_maintenances::builders::ListDomainMaintenancesFluentBuilder::set_next_token):<br>required: **false**<br><p>If your initial <code>ListDomainMaintenances</code> operation returns a <code>nextToken</code>, include the returned <code>nextToken</code> in subsequent <code>ListDomainMaintenances</code> operations, which returns results in the next page.</p><br>
12    /// - On success, responds with [`ListDomainMaintenancesOutput`](crate::operation::list_domain_maintenances::ListDomainMaintenancesOutput) with field(s):
13    ///   - [`domain_maintenances(Option<Vec::<DomainMaintenanceDetails>>)`](crate::operation::list_domain_maintenances::ListDomainMaintenancesOutput::domain_maintenances): <p>A list of the submitted maintenance actions.</p>
14    ///   - [`next_token(Option<String>)`](crate::operation::list_domain_maintenances::ListDomainMaintenancesOutput::next_token): <p>When <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.</p>
15    /// - On failure, responds with [`SdkError<ListDomainMaintenancesError>`](crate::operation::list_domain_maintenances::ListDomainMaintenancesError)
16    pub fn list_domain_maintenances(&self) -> crate::operation::list_domain_maintenances::builders::ListDomainMaintenancesFluentBuilder {
17        crate::operation::list_domain_maintenances::builders::ListDomainMaintenancesFluentBuilder::new(self.handle.clone())
18    }
19}