1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetOrganizationsAccessReport`](crate::operation::get_organizations_access_report::builders::GetOrganizationsAccessReportFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`job_id(impl Into<String>)`](crate::operation::get_organizations_access_report::builders::GetOrganizationsAccessReportFluentBuilder::job_id) / [`set_job_id(Option<String>)`](crate::operation::get_organizations_access_report::builders::GetOrganizationsAccessReportFluentBuilder::set_job_id):<br>required: **true**<br><p>The identifier of the request generated by the <code>GenerateOrganizationsAccessReport</code> operation.</p><br>
    ///   - [`max_items(i32)`](crate::operation::get_organizations_access_report::builders::GetOrganizationsAccessReportFluentBuilder::max_items) / [`set_max_items(Option<i32>)`](crate::operation::get_organizations_access_report::builders::GetOrganizationsAccessReportFluentBuilder::set_max_items):<br>required: **false**<br><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>  <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><br>
    ///   - [`marker(impl Into<String>)`](crate::operation::get_organizations_access_report::builders::GetOrganizationsAccessReportFluentBuilder::marker) / [`set_marker(Option<String>)`](crate::operation::get_organizations_access_report::builders::GetOrganizationsAccessReportFluentBuilder::set_marker):<br>required: **false**<br><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><br>
    ///   - [`sort_key(SortKeyType)`](crate::operation::get_organizations_access_report::builders::GetOrganizationsAccessReportFluentBuilder::sort_key) / [`set_sort_key(Option<SortKeyType>)`](crate::operation::get_organizations_access_report::builders::GetOrganizationsAccessReportFluentBuilder::set_sort_key):<br>required: **false**<br><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><br>
    /// - On success, responds with [`GetOrganizationsAccessReportOutput`](crate::operation::get_organizations_access_report::GetOrganizationsAccessReportOutput) with field(s):
    ///   - [`job_status(JobStatusType)`](crate::operation::get_organizations_access_report::GetOrganizationsAccessReportOutput::job_status): <p>The status of the job.</p>
    ///   - [`job_creation_date(DateTime)`](crate::operation::get_organizations_access_report::GetOrganizationsAccessReportOutput::job_creation_date): <p>The date and time, in&nbsp;<a href="http://www.iso.org/iso/iso8601">ISO 8601 date-time format</a>, when the report job was created.</p>
    ///   - [`job_completion_date(Option<DateTime>)`](crate::operation::get_organizations_access_report::GetOrganizationsAccessReportOutput::job_completion_date): <p>The date and time, in&nbsp;<a href="http://www.iso.org/iso/iso8601">ISO 8601 date-time format</a>, when the generated report job was completed or failed.</p>  <p>This field is null if the job is still in progress, as indicated by a job status value of <code>IN_PROGRESS</code>.</p>
    ///   - [`number_of_services_accessible(Option<i32>)`](crate::operation::get_organizations_access_report::GetOrganizationsAccessReportOutput::number_of_services_accessible): <p>The number of services that the applicable SCPs allow account principals to access.</p>
    ///   - [`number_of_services_not_accessed(Option<i32>)`](crate::operation::get_organizations_access_report::GetOrganizationsAccessReportOutput::number_of_services_not_accessed): <p>The number of services that account principals are allowed but did not attempt to access.</p>
    ///   - [`access_details(Option<Vec::<AccessDetail>>)`](crate::operation::get_organizations_access_report::GetOrganizationsAccessReportOutput::access_details): <p>An&nbsp;object that contains details about the most recent attempt to access the service.</p>
    ///   - [`is_truncated(bool)`](crate::operation::get_organizations_access_report::GetOrganizationsAccessReportOutput::is_truncated): <p>A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the <code>Marker</code> request parameter to retrieve more items. Note that IAM might return fewer than the <code>MaxItems</code> number of results even when there are more results available. We recommend that you check <code>IsTruncated</code> after every call to ensure that you receive all your results.</p>
    ///   - [`marker(Option<String>)`](crate::operation::get_organizations_access_report::GetOrganizationsAccessReportOutput::marker): <p>When <code>IsTruncated</code> is <code>true</code>, this element is present and contains the value to use for the <code>Marker</code> parameter in a subsequent pagination request.</p>
    ///   - [`error_details(Option<ErrorDetails>)`](crate::operation::get_organizations_access_report::GetOrganizationsAccessReportOutput::error_details): <p>Contains information about the reason that the operation failed.</p>  <p>This data type is used as a response element in the <code>GetOrganizationsAccessReport</code>, <code>GetServiceLastAccessedDetails</code>, and <code>GetServiceLastAccessedDetailsWithEntities</code> operations.</p>
    /// - On failure, responds with [`SdkError<GetOrganizationsAccessReportError>`](crate::operation::get_organizations_access_report::GetOrganizationsAccessReportError)
    pub fn get_organizations_access_report(
        &self,
    ) -> crate::operation::get_organizations_access_report::builders::GetOrganizationsAccessReportFluentBuilder {
        crate::operation::get_organizations_access_report::builders::GetOrganizationsAccessReportFluentBuilder::new(self.handle.clone())
    }
}