Skip to main content

aws_sdk_iam/operation/get_organizations_access_report/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::get_organizations_access_report::_get_organizations_access_report_output::GetOrganizationsAccessReportOutputBuilder;
3
4pub use crate::operation::get_organizations_access_report::_get_organizations_access_report_input::GetOrganizationsAccessReportInputBuilder;
5
6impl crate::operation::get_organizations_access_report::builders::GetOrganizationsAccessReportInputBuilder {
7    /// Sends a request with this input using the given client.
8    pub async fn send_with(
9        self,
10        client: &crate::Client,
11    ) -> ::std::result::Result<
12        crate::operation::get_organizations_access_report::GetOrganizationsAccessReportOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::get_organizations_access_report::GetOrganizationsAccessReportError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.get_organizations_access_report();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `GetOrganizationsAccessReport`.
24///
25/// <p>Retrieves the service last accessed data report for Organizations that was previously generated using the <code> <a href="https://docs.aws.amazon.com/IAM/latest/APIReference/API_GenerateOrganizationsAccessReport.html">GenerateOrganizationsAccessReport</a> </code> operation. This operation retrieves the status of your report job and the report contents.</p>
26/// <p>Depending on the parameters that you passed when you generated the report, the data returned could include different information. For details, see <a href="https://docs.aws.amazon.com/IAM/latest/APIReference/API_GenerateOrganizationsAccessReport.html">GenerateOrganizationsAccessReport</a>.</p>
27/// <p>To call this operation, you must be signed in to the management account in your organization. SCPs must be enabled for your organization root. You must have permissions to perform this operation. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html">Refining permissions using service last accessed data</a> in the <i>IAM User Guide</i>.</p>
28/// <p>For each service that principals in an account (root user, IAM users, or IAM roles) could access using SCPs, the operation returns details about the most recent access attempt. If there was no attempt, the service is listed without details about the most recent attempt to access the service. If the operation fails, it returns the reason that it failed.</p>
29/// <p>By default, the list is sorted by service namespace.</p>
30#[derive(::std::clone::Clone, ::std::fmt::Debug)]
31pub struct GetOrganizationsAccessReportFluentBuilder {
32    handle: ::std::sync::Arc<crate::client::Handle>,
33    inner: crate::operation::get_organizations_access_report::builders::GetOrganizationsAccessReportInputBuilder,
34    config_override: ::std::option::Option<crate::config::Builder>,
35}
36impl
37    crate::client::customize::internal::CustomizableSend<
38        crate::operation::get_organizations_access_report::GetOrganizationsAccessReportOutput,
39        crate::operation::get_organizations_access_report::GetOrganizationsAccessReportError,
40    > for GetOrganizationsAccessReportFluentBuilder
41{
42    fn send(
43        self,
44        config_override: crate::config::Builder,
45    ) -> crate::client::customize::internal::BoxFuture<
46        crate::client::customize::internal::SendResult<
47            crate::operation::get_organizations_access_report::GetOrganizationsAccessReportOutput,
48            crate::operation::get_organizations_access_report::GetOrganizationsAccessReportError,
49        >,
50    > {
51        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
52    }
53}
54impl GetOrganizationsAccessReportFluentBuilder {
55    /// Creates a new `GetOrganizationsAccessReportFluentBuilder`.
56    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
57        Self {
58            handle,
59            inner: ::std::default::Default::default(),
60            config_override: ::std::option::Option::None,
61        }
62    }
63    /// Access the GetOrganizationsAccessReport as a reference.
64    pub fn as_input(&self) -> &crate::operation::get_organizations_access_report::builders::GetOrganizationsAccessReportInputBuilder {
65        &self.inner
66    }
67    /// Sends the request and returns the response.
68    ///
69    /// If an error occurs, an `SdkError` will be returned with additional details that
70    /// can be matched against.
71    ///
72    /// By default, any retryable failures will be retried twice. Retry behavior
73    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
74    /// set when configuring the client.
75    pub async fn send(
76        self,
77    ) -> ::std::result::Result<
78        crate::operation::get_organizations_access_report::GetOrganizationsAccessReportOutput,
79        ::aws_smithy_runtime_api::client::result::SdkError<
80            crate::operation::get_organizations_access_report::GetOrganizationsAccessReportError,
81            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
82        >,
83    > {
84        let input = self
85            .inner
86            .build()
87            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
88        let runtime_plugins = crate::operation::get_organizations_access_report::GetOrganizationsAccessReport::operation_runtime_plugins(
89            self.handle.runtime_plugins.clone(),
90            &self.handle.conf,
91            self.config_override,
92        );
93        crate::operation::get_organizations_access_report::GetOrganizationsAccessReport::orchestrate(&runtime_plugins, input).await
94    }
95
96    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
97    pub fn customize(
98        self,
99    ) -> crate::client::customize::CustomizableOperation<
100        crate::operation::get_organizations_access_report::GetOrganizationsAccessReportOutput,
101        crate::operation::get_organizations_access_report::GetOrganizationsAccessReportError,
102        Self,
103    > {
104        crate::client::customize::CustomizableOperation::new(self)
105    }
106    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
107        self.set_config_override(::std::option::Option::Some(config_override.into()));
108        self
109    }
110
111    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
112        self.config_override = config_override;
113        self
114    }
115    /// <p>The identifier of the request generated by the <a href="https://docs.aws.amazon.com/IAM/latest/APIReference/API_GenerateOrganizationsAccessReport.html">GenerateOrganizationsAccessReport</a> operation.</p>
116    pub fn job_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
117        self.inner = self.inner.job_id(input.into());
118        self
119    }
120    /// <p>The identifier of the request generated by the <a href="https://docs.aws.amazon.com/IAM/latest/APIReference/API_GenerateOrganizationsAccessReport.html">GenerateOrganizationsAccessReport</a> operation.</p>
121    pub fn set_job_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
122        self.inner = self.inner.set_job_id(input);
123        self
124    }
125    /// <p>The identifier of the request generated by the <a href="https://docs.aws.amazon.com/IAM/latest/APIReference/API_GenerateOrganizationsAccessReport.html">GenerateOrganizationsAccessReport</a> operation.</p>
126    pub fn get_job_id(&self) -> &::std::option::Option<::std::string::String> {
127        self.inner.get_job_id()
128    }
129    /// <p>Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</p>
130    /// <p>If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the <code>IsTruncated</code> response element returns <code>true</code>, and <code>Marker</code> contains a value to include in the subsequent call that tells the service where to continue from.</p>
131    pub fn max_items(mut self, input: i32) -> Self {
132        self.inner = self.inner.max_items(input);
133        self
134    }
135    /// <p>Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</p>
136    /// <p>If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the <code>IsTruncated</code> response element returns <code>true</code>, and <code>Marker</code> contains a value to include in the subsequent call that tells the service where to continue from.</p>
137    pub fn set_max_items(mut self, input: ::std::option::Option<i32>) -> Self {
138        self.inner = self.inner.set_max_items(input);
139        self
140    }
141    /// <p>Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</p>
142    /// <p>If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the <code>IsTruncated</code> response element returns <code>true</code>, and <code>Marker</code> contains a value to include in the subsequent call that tells the service where to continue from.</p>
143    pub fn get_max_items(&self) -> &::std::option::Option<i32> {
144        self.inner.get_max_items()
145    }
146    /// <p>Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the <code>Marker</code> element in the response that you received to indicate where the next call should start.</p>
147    pub fn marker(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
148        self.inner = self.inner.marker(input.into());
149        self
150    }
151    /// <p>Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the <code>Marker</code> element in the response that you received to indicate where the next call should start.</p>
152    pub fn set_marker(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
153        self.inner = self.inner.set_marker(input);
154        self
155    }
156    /// <p>Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the <code>Marker</code> element in the response that you received to indicate where the next call should start.</p>
157    pub fn get_marker(&self) -> &::std::option::Option<::std::string::String> {
158        self.inner.get_marker()
159    }
160    /// <p>The key that is used to sort the results. If you choose the namespace key, the results are returned in alphabetical order. If you choose the time key, the results are sorted numerically by the date and time.</p>
161    pub fn sort_key(mut self, input: crate::types::SortKeyType) -> Self {
162        self.inner = self.inner.sort_key(input);
163        self
164    }
165    /// <p>The key that is used to sort the results. If you choose the namespace key, the results are returned in alphabetical order. If you choose the time key, the results are sorted numerically by the date and time.</p>
166    pub fn set_sort_key(mut self, input: ::std::option::Option<crate::types::SortKeyType>) -> Self {
167        self.inner = self.inner.set_sort_key(input);
168        self
169    }
170    /// <p>The key that is used to sort the results. If you choose the namespace key, the results are returned in alphabetical order. If you choose the time key, the results are sorted numerically by the date and time.</p>
171    pub fn get_sort_key(&self) -> &::std::option::Option<crate::types::SortKeyType> {
172        self.inner.get_sort_key()
173    }
174}