aws_sdk_accessanalyzer/client/start_policy_generation.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 [`StartPolicyGeneration`](crate::operation::start_policy_generation::builders::StartPolicyGenerationFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`policy_generation_details(PolicyGenerationDetails)`](crate::operation::start_policy_generation::builders::StartPolicyGenerationFluentBuilder::policy_generation_details) / [`set_policy_generation_details(Option<PolicyGenerationDetails>)`](crate::operation::start_policy_generation::builders::StartPolicyGenerationFluentBuilder::set_policy_generation_details):<br>required: **true**<br><p>Contains the ARN of the IAM entity (user or role) for which you are generating a policy.</p><br>
7 /// - [`cloud_trail_details(CloudTrailDetails)`](crate::operation::start_policy_generation::builders::StartPolicyGenerationFluentBuilder::cloud_trail_details) / [`set_cloud_trail_details(Option<CloudTrailDetails>)`](crate::operation::start_policy_generation::builders::StartPolicyGenerationFluentBuilder::set_cloud_trail_details):<br>required: **false**<br><p>A <code>CloudTrailDetails</code> object that contains details about a <code>Trail</code> that you want to analyze to generate policies.</p><br>
8 /// - [`client_token(impl Into<String>)`](crate::operation::start_policy_generation::builders::StartPolicyGenerationFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::start_policy_generation::builders::StartPolicyGenerationFluentBuilder::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, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect.</p> <p>If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.</p><br>
9 /// - On success, responds with [`StartPolicyGenerationOutput`](crate::operation::start_policy_generation::StartPolicyGenerationOutput) with field(s):
10 /// - [`job_id(String)`](crate::operation::start_policy_generation::StartPolicyGenerationOutput::job_id): <p>The <code>JobId</code> that is returned by the <code>StartPolicyGeneration</code> operation. The <code>JobId</code> can be used with <code>GetGeneratedPolicy</code> to retrieve the generated policies or used with <code>CancelPolicyGeneration</code> to cancel the policy generation request.</p>
11 /// - On failure, responds with [`SdkError<StartPolicyGenerationError>`](crate::operation::start_policy_generation::StartPolicyGenerationError)
12 pub fn start_policy_generation(&self) -> crate::operation::start_policy_generation::builders::StartPolicyGenerationFluentBuilder {
13 crate::operation::start_policy_generation::builders::StartPolicyGenerationFluentBuilder::new(self.handle.clone())
14 }
15}