aws_sdk_applicationsignals/client/
list_service_states.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 [`ListServiceStates`](crate::operation::list_service_states::builders::ListServiceStatesFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_service_states::builders::ListServiceStatesFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`start_time(DateTime)`](crate::operation::list_service_states::builders::ListServiceStatesFluentBuilder::start_time) / [`set_start_time(Option<DateTime>)`](crate::operation::list_service_states::builders::ListServiceStatesFluentBuilder::set_start_time):<br>required: **true**<br><p>The start of the time period to retrieve service state information for. When used in a raw HTTP Query API, it is formatted as epoch time in seconds. For example, <code>1698778057</code>.</p><br>
8    ///   - [`end_time(DateTime)`](crate::operation::list_service_states::builders::ListServiceStatesFluentBuilder::end_time) / [`set_end_time(Option<DateTime>)`](crate::operation::list_service_states::builders::ListServiceStatesFluentBuilder::set_end_time):<br>required: **true**<br><p>The end of the time period to retrieve service state information for. When used in a raw HTTP Query API, it is formatted as epoch time in seconds. For example, <code>1698778057</code>.</p><br>
9    ///   - [`max_results(i32)`](crate::operation::list_service_states::builders::ListServiceStatesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_service_states::builders::ListServiceStatesFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of service states to return in one operation. If you omit this parameter, the default of 20 is used.</p><br>
10    ///   - [`next_token(impl Into<String>)`](crate::operation::list_service_states::builders::ListServiceStatesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_service_states::builders::ListServiceStatesFluentBuilder::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 service states.</p><br>
11    ///   - [`include_linked_accounts(bool)`](crate::operation::list_service_states::builders::ListServiceStatesFluentBuilder::include_linked_accounts) / [`set_include_linked_accounts(Option<bool>)`](crate::operation::list_service_states::builders::ListServiceStatesFluentBuilder::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 service states from source accounts in the returned data.</p><br>
12    ///   - [`aws_account_id(impl Into<String>)`](crate::operation::list_service_states::builders::ListServiceStatesFluentBuilder::aws_account_id) / [`set_aws_account_id(Option<String>)`](crate::operation::list_service_states::builders::ListServiceStatesFluentBuilder::set_aws_account_id):<br>required: **false**<br><p>The Amazon Web Services account ID to filter service states by. Use this to limit results to services from a specific account.</p><br>
13    ///   - [`attribute_filters(AttributeFilter)`](crate::operation::list_service_states::builders::ListServiceStatesFluentBuilder::attribute_filters) / [`set_attribute_filters(Option<Vec::<AttributeFilter>>)`](crate::operation::list_service_states::builders::ListServiceStatesFluentBuilder::set_attribute_filters):<br>required: **false**<br><p>A list of attribute filters to narrow down the services. You can filter by platform, environment, or other service attributes.</p><br>
14    /// - On success, responds with [`ListServiceStatesOutput`](crate::operation::list_service_states::ListServiceStatesOutput) with field(s):
15    ///   - [`start_time(DateTime)`](crate::operation::list_service_states::ListServiceStatesOutput::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 epoch time in seconds. For example, <code>1698778057</code>.</p>
16    ///   - [`end_time(DateTime)`](crate::operation::list_service_states::ListServiceStatesOutput::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 epoch time in seconds. For example, <code>1698778057</code>.</p>
17    ///   - [`service_states(Vec::<ServiceState>)`](crate::operation::list_service_states::ListServiceStatesOutput::service_states): <p>An array of structures, where each structure contains information about the state of one service, including its latest change events such as deployments.</p>
18    ///   - [`next_token(Option<String>)`](crate::operation::list_service_states::ListServiceStatesOutput::next_token): <p>Include this value in your next use of this API to get the next set of service states.</p>
19    /// - On failure, responds with [`SdkError<ListServiceStatesError>`](crate::operation::list_service_states::ListServiceStatesError)
20    pub fn list_service_states(&self) -> crate::operation::list_service_states::builders::ListServiceStatesFluentBuilder {
21        crate::operation::list_service_states::builders::ListServiceStatesFluentBuilder::new(self.handle.clone())
22    }
23}
aws_sdk_applicationsignals/client/list_service_states.rs

aws_sdk_applicationsignals/client/
list_service_states.rs
