aws_sdk_securityhub/client/list_free_trial_statuses_v2.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 [`ListFreeTrialStatusesV2`](crate::operation::list_free_trial_statuses_v2::builders::ListFreeTrialStatusesV2FluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_free_trial_statuses_v2::builders::ListFreeTrialStatusesV2FluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`account_ids(impl Into<String>)`](crate::operation::list_free_trial_statuses_v2::builders::ListFreeTrialStatusesV2FluentBuilder::account_ids) / [`set_account_ids(Option<Vec::<String>>)`](crate::operation::list_free_trial_statuses_v2::builders::ListFreeTrialStatusesV2FluentBuilder::set_account_ids):<br>required: **false**<br><p>The Amazon Web Services account identifiers to list free trial status for. You can specify accounts other than your own only if you are a delegated Security Hub administrator.</p><br>
8 /// - [`statuses(FreeTrialStatusValue)`](crate::operation::list_free_trial_statuses_v2::builders::ListFreeTrialStatusesV2FluentBuilder::statuses) / [`set_statuses(Option<Vec::<FreeTrialStatusValue>>)`](crate::operation::list_free_trial_statuses_v2::builders::ListFreeTrialStatusesV2FluentBuilder::set_statuses):<br>required: **false**<br><p>The free trial statuses to filter the results by. Valid values:</p> <ul> <li> <p><code>ACTIVE</code> returns only features with an ongoing free trial period.</p></li> <li> <p><code>INACTIVE</code> returns only features whose free trial period has ended, or that never started.</p></li> </ul><br>
9 /// - [`max_results(i32)`](crate::operation::list_free_trial_statuses_v2::builders::ListFreeTrialStatusesV2FluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_free_trial_statuses_v2::builders::ListFreeTrialStatusesV2FluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return. If you don't specify a value, Security Hub returns up to 100 results.</p><br>
10 /// - [`next_token(impl Into<String>)`](crate::operation::list_free_trial_statuses_v2::builders::ListFreeTrialStatusesV2FluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_free_trial_statuses_v2::builders::ListFreeTrialStatusesV2FluentBuilder::set_next_token):<br>required: **false**<br><p>The pagination token to request the next page of results.</p><br>
11 /// - On success, responds with [`ListFreeTrialStatusesV2Output`](crate::operation::list_free_trial_statuses_v2::ListFreeTrialStatusesV2Output) with field(s):
12 /// - [`account_free_trial_statuses(Option<Vec::<AccountFreeTrialStatus>>)`](crate::operation::list_free_trial_statuses_v2::ListFreeTrialStatusesV2Output::account_free_trial_statuses): <p>An array of free trial statuses, one for each account in scope.</p>
13 /// - [`next_token(Option<String>)`](crate::operation::list_free_trial_statuses_v2::ListFreeTrialStatusesV2Output::next_token): <p>The pagination token to use to request the next page of results. If there are no additional results, this value is null.</p>
14 /// - On failure, responds with [`SdkError<ListFreeTrialStatusesV2Error>`](crate::operation::list_free_trial_statuses_v2::ListFreeTrialStatusesV2Error)
15 pub fn list_free_trial_statuses_v2(&self) -> crate::operation::list_free_trial_statuses_v2::builders::ListFreeTrialStatusesV2FluentBuilder {
16 crate::operation::list_free_trial_statuses_v2::builders::ListFreeTrialStatusesV2FluentBuilder::new(self.handle.clone())
17 }
18}