Skip to main content

aws_sdk_bedrockagentcorecontrol/client/
get_policy_summary.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 [`GetPolicySummary`](crate::operation::get_policy_summary::builders::GetPolicySummaryFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`policy_engine_id(impl Into<String>)`](crate::operation::get_policy_summary::builders::GetPolicySummaryFluentBuilder::policy_engine_id) / [`set_policy_engine_id(Option<String>)`](crate::operation::get_policy_summary::builders::GetPolicySummaryFluentBuilder::set_policy_engine_id):<br>required: **true**<br><p>The identifier of the policy engine that manages the policy to retrieve the summary for.</p><br>
7    ///   - [`policy_id(impl Into<String>)`](crate::operation::get_policy_summary::builders::GetPolicySummaryFluentBuilder::policy_id) / [`set_policy_id(Option<String>)`](crate::operation::get_policy_summary::builders::GetPolicySummaryFluentBuilder::set_policy_id):<br>required: **true**<br><p>The unique identifier of the policy to retrieve the summary for. This must be a valid policy ID that exists within the specified policy engine.</p><br>
8    /// - On success, responds with [`GetPolicySummaryOutput`](crate::operation::get_policy_summary::GetPolicySummaryOutput) with field(s):
9    ///   - [`policy_id(String)`](crate::operation::get_policy_summary::GetPolicySummaryOutput::policy_id): <p>The unique identifier of the policy.</p>
10    ///   - [`name(String)`](crate::operation::get_policy_summary::GetPolicySummaryOutput::name): <p>The customer-assigned name of the policy.</p>
11    ///   - [`policy_engine_id(String)`](crate::operation::get_policy_summary::GetPolicySummaryOutput::policy_engine_id): <p>The identifier of the policy engine that manages this policy.</p>
12    ///   - [`created_at(DateTime)`](crate::operation::get_policy_summary::GetPolicySummaryOutput::created_at): <p>The timestamp when the policy was originally created.</p>
13    ///   - [`updated_at(DateTime)`](crate::operation::get_policy_summary::GetPolicySummaryOutput::updated_at): <p>The timestamp when the policy was last modified.</p>
14    ///   - [`policy_arn(String)`](crate::operation::get_policy_summary::GetPolicySummaryOutput::policy_arn): <p>The Amazon Resource Name (ARN) of the policy.</p>
15    ///   - [`status(PolicyStatus)`](crate::operation::get_policy_summary::GetPolicySummaryOutput::status): <p>The current status of the policy.</p>
16    /// - On failure, responds with [`SdkError<GetPolicySummaryError>`](crate::operation::get_policy_summary::GetPolicySummaryError)
17    pub fn get_policy_summary(&self) -> crate::operation::get_policy_summary::builders::GetPolicySummaryFluentBuilder {
18        crate::operation::get_policy_summary::builders::GetPolicySummaryFluentBuilder::new(self.handle.clone())
19    }
20}