aws_sdk_resourceexplorer2/client/
get_resource_explorer_setup.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 [`GetResourceExplorerSetup`](crate::operation::get_resource_explorer_setup::builders::GetResourceExplorerSetupFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::get_resource_explorer_setup::builders::GetResourceExplorerSetupFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`task_id(impl Into<String>)`](crate::operation::get_resource_explorer_setup::builders::GetResourceExplorerSetupFluentBuilder::task_id) / [`set_task_id(Option<String>)`](crate::operation::get_resource_explorer_setup::builders::GetResourceExplorerSetupFluentBuilder::set_task_id):<br>required: **true**<br><p>The unique identifier of the setup task to retrieve status information for. This ID is returned by <code>CreateResourceExplorerSetup</code> or <code>DeleteResourceExplorerSetup</code> operations.</p><br>
8    ///   - [`max_results(i32)`](crate::operation::get_resource_explorer_setup::builders::GetResourceExplorerSetupFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::get_resource_explorer_setup::builders::GetResourceExplorerSetupFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of Region status results to return in a single response. Valid values are between <code>1</code> and <code>100</code>.</p><br>
9    ///   - [`next_token(impl Into<String>)`](crate::operation::get_resource_explorer_setup::builders::GetResourceExplorerSetupFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::get_resource_explorer_setup::builders::GetResourceExplorerSetupFluentBuilder::set_next_token):<br>required: **false**<br><p>The pagination token from a previous <code>GetResourceExplorerSetup</code> response. Use this token to retrieve the next set of results.</p><br>
10    /// - On success, responds with [`GetResourceExplorerSetupOutput`](crate::operation::get_resource_explorer_setup::GetResourceExplorerSetupOutput) with field(s):
11    ///   - [`regions(Option<Vec::<RegionStatus>>)`](crate::operation::get_resource_explorer_setup::GetResourceExplorerSetupOutput::regions): <p>A list of Region status objects that describe the current state of Resource Explorer configuration in each Region.</p>
12    ///   - [`next_token(Option<String>)`](crate::operation::get_resource_explorer_setup::GetResourceExplorerSetupOutput::next_token): <p>The pagination token to use in a subsequent <code>GetResourceExplorerSetup</code> request to retrieve the next set of results.</p>
13    /// - On failure, responds with [`SdkError<GetResourceExplorerSetupError>`](crate::operation::get_resource_explorer_setup::GetResourceExplorerSetupError)
14    pub fn get_resource_explorer_setup(&self) -> crate::operation::get_resource_explorer_setup::builders::GetResourceExplorerSetupFluentBuilder {
15        crate::operation::get_resource_explorer_setup::builders::GetResourceExplorerSetupFluentBuilder::new(self.handle.clone())
16    }
17}