aws_sdk_resiliencehub/client/
list_apps.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 [`ListApps`](crate::operation::list_apps::builders::ListAppsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_apps::builders::ListAppsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`next_token(impl Into<String>)`](crate::operation::list_apps::builders::ListAppsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_apps::builders::ListAppsFluentBuilder::set_next_token):<br>required: **false**<br><p>Null, or the token from a previous call to get the next set of results.</p><br>
8    ///   - [`max_results(i32)`](crate::operation::list_apps::builders::ListAppsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_apps::builders::ListAppsFluentBuilder::set_max_results):<br>required: **false**<br><p>Maximum number of results to include in the response. If more results exist than the specified <code>MaxResults</code> value, a token is included in the response so that the remaining results can be retrieved.</p><br>
9    ///   - [`name(impl Into<String>)`](crate::operation::list_apps::builders::ListAppsFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::list_apps::builders::ListAppsFluentBuilder::set_name):<br>required: **false**<br><p>The name for the one of the listed applications.</p><br>
10    ///   - [`app_arn(impl Into<String>)`](crate::operation::list_apps::builders::ListAppsFluentBuilder::app_arn) / [`set_app_arn(Option<String>)`](crate::operation::list_apps::builders::ListAppsFluentBuilder::set_app_arn):<br>required: **false**<br><p>Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:<code>partition</code>:resiliencehub:<code>region</code>:<code>account</code>:app/<code>app-id</code>. For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html"> Amazon Resource Names (ARNs)</a> in the <i>Amazon Web Services General Reference</i> guide.</p><br>
11    ///   - [`from_last_assessment_time(DateTime)`](crate::operation::list_apps::builders::ListAppsFluentBuilder::from_last_assessment_time) / [`set_from_last_assessment_time(Option<DateTime>)`](crate::operation::list_apps::builders::ListAppsFluentBuilder::set_from_last_assessment_time):<br>required: **false**<br><p>Lower limit of the range that is used to filter applications based on their last assessment times.</p><br>
12    ///   - [`to_last_assessment_time(DateTime)`](crate::operation::list_apps::builders::ListAppsFluentBuilder::to_last_assessment_time) / [`set_to_last_assessment_time(Option<DateTime>)`](crate::operation::list_apps::builders::ListAppsFluentBuilder::set_to_last_assessment_time):<br>required: **false**<br><p>Upper limit of the range that is used to filter the applications based on their last assessment times.</p><br>
13    ///   - [`reverse_order(bool)`](crate::operation::list_apps::builders::ListAppsFluentBuilder::reverse_order) / [`set_reverse_order(Option<bool>)`](crate::operation::list_apps::builders::ListAppsFluentBuilder::set_reverse_order):<br>required: **false**<br><p>The application list is sorted based on the values of <code>lastAppComplianceEvaluationTime</code> field. By default, application list is sorted in ascending order. To sort the application list in descending order, set this field to <code>True</code>.</p><br>
14    ///   - [`aws_application_arn(impl Into<String>)`](crate::operation::list_apps::builders::ListAppsFluentBuilder::aws_application_arn) / [`set_aws_application_arn(Option<String>)`](crate::operation::list_apps::builders::ListAppsFluentBuilder::set_aws_application_arn):<br>required: **false**<br><p>Amazon Resource Name (ARN) of Resource Groups group that is integrated with an AppRegistry application. For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html"> Amazon Resource Names (ARNs)</a> in the <i>Amazon Web Services General Reference</i> guide.</p><br>
15    /// - On success, responds with [`ListAppsOutput`](crate::operation::list_apps::ListAppsOutput) with field(s):
16    ///   - [`app_summaries(Vec::<AppSummary>)`](crate::operation::list_apps::ListAppsOutput::app_summaries): <p>Summaries for the Resilience Hub application.</p>
17    ///   - [`next_token(Option<String>)`](crate::operation::list_apps::ListAppsOutput::next_token): <p>Token for the next set of results, or null if there are no more results.</p>
18    /// - On failure, responds with [`SdkError<ListAppsError>`](crate::operation::list_apps::ListAppsError)
19    pub fn list_apps(&self) -> crate::operation::list_apps::builders::ListAppsFluentBuilder {
20        crate::operation::list_apps::builders::ListAppsFluentBuilder::new(self.handle.clone())
21    }
22}