aws_sdk_applicationsignals/client/
list_services.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 [`ListServices`](crate::operation::list_services::builders::ListServicesFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_services::builders::ListServicesFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`start_time(DateTime)`](crate::operation::list_services::builders::ListServicesFluentBuilder::start_time) / [`set_start_time(Option<DateTime>)`](crate::operation::list_services::builders::ListServicesFluentBuilder::set_start_time):<br>required: **true**<br><p>The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: <code>1698778057</code></p> <p>Your requested start time will be rounded to the nearest hour.</p><br>
8    ///   - [`end_time(DateTime)`](crate::operation::list_services::builders::ListServicesFluentBuilder::end_time) / [`set_end_time(Option<DateTime>)`](crate::operation::list_services::builders::ListServicesFluentBuilder::set_end_time):<br>required: **true**<br><p>The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: <code>1698778057</code></p> <p>Your requested start time will be rounded to the nearest hour.</p><br>
9    ///   - [`max_results(i32)`](crate::operation::list_services::builders::ListServicesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_services::builders::ListServicesFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return in one operation. If you omit this parameter, the default of 50 is used.</p><br>
10    ///   - [`next_token(impl Into<String>)`](crate::operation::list_services::builders::ListServicesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_services::builders::ListServicesFluentBuilder::set_next_token):<br>required: **false**<br><p>Include this value, if it was returned by the previous operation, to get the next set of services.</p><br>
11    ///   - [`include_linked_accounts(bool)`](crate::operation::list_services::builders::ListServicesFluentBuilder::include_linked_accounts) / [`set_include_linked_accounts(Option<bool>)`](crate::operation::list_services::builders::ListServicesFluentBuilder::set_include_linked_accounts):<br>required: **false**<br><p>If you are using this operation in a monitoring account, specify <code>true</code> to include services from source accounts in the returned data.</p><br>
12    ///   - [`aws_account_id(impl Into<String>)`](crate::operation::list_services::builders::ListServicesFluentBuilder::aws_account_id) / [`set_aws_account_id(Option<String>)`](crate::operation::list_services::builders::ListServicesFluentBuilder::set_aws_account_id):<br>required: **false**<br><p>Amazon Web Services Account ID.</p><br>
13    /// - On success, responds with [`ListServicesOutput`](crate::operation::list_services::ListServicesOutput) with field(s):
14    ///   - [`start_time(DateTime)`](crate::operation::list_services::ListServicesOutput::start_time): <p>The start of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: <code>1698778057</code></p> <p>This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.</p>
15    ///   - [`end_time(DateTime)`](crate::operation::list_services::ListServicesOutput::end_time): <p>The end of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: <code>1698778057</code></p> <p>This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.</p>
16    ///   - [`service_summaries(Vec::<ServiceSummary>)`](crate::operation::list_services::ListServicesOutput::service_summaries): <p>An array of structures, where each structure contains some information about a service. To get complete information about a service, use <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetService.html">GetService</a>.</p>
17    ///   - [`next_token(Option<String>)`](crate::operation::list_services::ListServicesOutput::next_token): <p>Include this value in your next use of this API to get next set of services.</p>
18    /// - On failure, responds with [`SdkError<ListServicesError>`](crate::operation::list_services::ListServicesError)
19    pub fn list_services(&self) -> crate::operation::list_services::builders::ListServicesFluentBuilder {
20        crate::operation::list_services::builders::ListServicesFluentBuilder::new(self.handle.clone())
21    }
22}