aws-sdk-accessanalyzer 1.105.0

AWS SDK for Access Analyzer
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`StartPolicyPreviewJob`](crate::operation::start_policy_preview_job::builders::StartPolicyPreviewJobFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`policy_configurations(PolicyConfiguration)`](crate::operation::start_policy_preview_job::builders::StartPolicyPreviewJobFluentBuilder::policy_configurations) / [`set_policy_configurations(Option<Vec::<PolicyConfiguration>>)`](crate::operation::start_policy_preview_job::builders::StartPolicyPreviewJobFluentBuilder::set_policy_configurations):<br>required: **true**<br><p>A list of policy configurations to analyze. Currently limited to one configuration per request. Each configuration specifies the job type, target ID, and policy documents to test.</p><br>
    ///   - [`start_time(DateTime)`](crate::operation::start_policy_preview_job::builders::StartPolicyPreviewJobFluentBuilder::start_time) / [`set_start_time(Option<DateTime>)`](crate::operation::start_policy_preview_job::builders::StartPolicyPreviewJobFluentBuilder::set_start_time):<br>required: **true**<br><p>The start of the CloudTrail event analysis window. The analysis will evaluate events from this time forward.</p><br>
    ///   - [`end_time(DateTime)`](crate::operation::start_policy_preview_job::builders::StartPolicyPreviewJobFluentBuilder::end_time) / [`set_end_time(Option<DateTime>)`](crate::operation::start_policy_preview_job::builders::StartPolicyPreviewJobFluentBuilder::set_end_time):<br>required: **false**<br><p>The end of the analysis window. If not specified, defaults to the time of the request. The analysis will evaluate CloudTrail events up to this time.</p><br>
    ///   - [`output_s3_uri(impl Into<String>)`](crate::operation::start_policy_preview_job::builders::StartPolicyPreviewJobFluentBuilder::output_s3_uri) / [`set_output_s3_uri(Option<String>)`](crate::operation::start_policy_preview_job::builders::StartPolicyPreviewJobFluentBuilder::set_output_s3_uri):<br>required: **true**<br><p>The Amazon S3 URI where the completed analysis report will be stored. The Amazon S3 bucket must grant access to the IAM Access Analyzer service principal in its resource policy. The report will be stored at the path: <code>outputS3Uri/jobId/timestamp/</code>.</p><br>
    ///   - [`client_token(impl Into<String>)`](crate::operation::start_policy_preview_job::builders::StartPolicyPreviewJobFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::start_policy_preview_job::builders::StartPolicyPreviewJobFluentBuilder::set_client_token):<br>required: **false**<br><p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token return the result from the original successful request and have no additional effect.</p><br>
    /// - On success, responds with [`StartPolicyPreviewJobOutput`](crate::operation::start_policy_preview_job::StartPolicyPreviewJobOutput) with field(s):
    ///   - [`job_id(String)`](crate::operation::start_policy_preview_job::StartPolicyPreviewJobOutput::job_id): <p>The unique identifier for the created policy preview job. Use this ID with <code>GetPolicyPreviewJob</code> to retrieve job status and details, or with <code>CancelPolicyPreviewJob</code> to cancel the job.</p>
    /// - On failure, responds with [`SdkError<StartPolicyPreviewJobError>`](crate::operation::start_policy_preview_job::StartPolicyPreviewJobError)
    pub fn start_policy_preview_job(&self) -> crate::operation::start_policy_preview_job::builders::StartPolicyPreviewJobFluentBuilder {
        crate::operation::start_policy_preview_job::builders::StartPolicyPreviewJobFluentBuilder::new(self.handle.clone())
    }
}