aws-sdk-cloudwatchomni 1.2.0

AWS SDK for CloudWatch Omni
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListOmniDashboards`](crate::operation::list_omni_dashboards::builders::ListOmniDashboardsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_omni_dashboards::builders::ListOmniDashboardsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`space_id(impl Into<String>)`](crate::operation::list_omni_dashboards::builders::ListOmniDashboardsFluentBuilder::space_id) / [`set_space_id(Option<String>)`](crate::operation::list_omni_dashboards::builders::ListOmniDashboardsFluentBuilder::set_space_id):<br>required: **true**<br>The unique ID of the space.<br>
    ///   - [`name_prefix(impl Into<String>)`](crate::operation::list_omni_dashboards::builders::ListOmniDashboardsFluentBuilder::name_prefix) / [`set_name_prefix(Option<String>)`](crate::operation::list_omni_dashboards::builders::ListOmniDashboardsFluentBuilder::set_name_prefix):<br>required: **false**<br>Filter to dashboards whose name starts with this prefix.<br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_omni_dashboards::builders::ListOmniDashboardsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_omni_dashboards::builders::ListOmniDashboardsFluentBuilder::set_next_token):<br>required: **false**<br>A token to retrieve the next page of results.<br>
    ///   - [`max_results(i32)`](crate::operation::list_omni_dashboards::builders::ListOmniDashboardsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_omni_dashboards::builders::ListOmniDashboardsFluentBuilder::set_max_results):<br>required: **false**<br>The maximum number of dashboards to return per page. Defaults to 100. A page can contain fewer results than this value even when more results remain; continue while nextToken is present.<br>
    /// - On success, responds with [`ListOmniDashboardsOutput`](crate::operation::list_omni_dashboards::ListOmniDashboardsOutput) with field(s):
    ///   - [`items(Vec::<OmniDashboardSummary>)`](crate::operation::list_omni_dashboards::ListOmniDashboardsOutput::items): The list of dashboard summaries.
    ///   - [`next_token(Option<String>)`](crate::operation::list_omni_dashboards::ListOmniDashboardsOutput::next_token): A token to retrieve the next page of results, or null if there are no more results.
    /// - On failure, responds with [`SdkError<ListOmniDashboardsError>`](crate::operation::list_omni_dashboards::ListOmniDashboardsError)
    pub fn list_omni_dashboards(&self) -> crate::operation::list_omni_dashboards::builders::ListOmniDashboardsFluentBuilder {
        crate::operation::list_omni_dashboards::builders::ListOmniDashboardsFluentBuilder::new(self.handle.clone())
    }
}