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 time for the service states query. Only service states from this time onward will be included. Specify the time as the number of milliseconds since January 1, 1970, 00:00:00 UTC.</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 time for the service states query. Only service states before this time will be included. Specify the time as the number of milliseconds since January 1, 1970, 00:00:00 UTC.</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 a single request. Valid range is 1 to 100. If not specified, defaults to 50.</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>The token for the next set of results. Use this token to retrieve additional pages of service states when the result set is large.</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>Specifies whether to include service states from linked AWS accounts in the results. Set to <code>true</code> to include linked accounts, or <code>false</code> to only include the current account. Defaults to <code>false</code>.</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 AWS account ID to filter service states. If specified, only service states from this account will be returned. If not specified, service states from the current account (and linked accounts if enabled) are returned.</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>An array of attribute filters to narrow down the service states returned. Each filter specifies an attribute name and the values to match against.</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 time of the query range, expressed as the number of milliseconds since January 1, 1970, 00:00:00 UTC.</p>
16    ///   - [`end_time(DateTime)`](crate::operation::list_service_states::ListServiceStatesOutput::end_time): <p>The end time of the query range, expressed as the number of milliseconds since January 1, 1970, 00:00:00 UTC.</p>
17    ///   - [`service_states(Vec::<ServiceState>)`](crate::operation::list_service_states::ListServiceStatesOutput::service_states): <p>An array of service state objects that match the specified criteria. Each service state includes current status, recent change events, and service metadata.</p>
18    ///   - [`next_token(Option<String>)`](crate::operation::list_service_states::ListServiceStatesOutput::next_token): <p>The token to use for retrieving the next page of results. This value is present only if there are more results available than were returned in the current response.</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
