aws_sdk_verifiedpermissions/client/
get_policy_store.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 [`GetPolicyStore`](crate::operation::get_policy_store::builders::GetPolicyStoreFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`policy_store_id(impl Into<String>)`](crate::operation::get_policy_store::builders::GetPolicyStoreFluentBuilder::policy_store_id) / [`set_policy_store_id(Option<String>)`](crate::operation::get_policy_store::builders::GetPolicyStoreFluentBuilder::set_policy_store_id):<br>required: **true**<br><p>Specifies the ID of the policy store that you want information about.</p><br>
7    ///   - [`tags(bool)`](crate::operation::get_policy_store::builders::GetPolicyStoreFluentBuilder::tags) / [`set_tags(Option<bool>)`](crate::operation::get_policy_store::builders::GetPolicyStoreFluentBuilder::set_tags):<br>required: **false**<br><p>Specifies whether to return the tags that are attached to the policy store. If this parameter is included in the API call, the tags are returned, otherwise they are not returned.</p><note>  <p>If this parameter is included in the API call but there are no tags attached to the policy store, the <code>tags</code> response parameter is omitted from the response.</p> </note><br>
8    /// - On success, responds with [`GetPolicyStoreOutput`](crate::operation::get_policy_store::GetPolicyStoreOutput) with field(s):
9    ///   - [`policy_store_id(String)`](crate::operation::get_policy_store::GetPolicyStoreOutput::policy_store_id): <p>The ID of the policy store;</p>
10    ///   - [`arn(String)`](crate::operation::get_policy_store::GetPolicyStoreOutput::arn): <p>The Amazon Resource Name (ARN) of the policy store.</p>
11    ///   - [`validation_settings(Option<ValidationSettings>)`](crate::operation::get_policy_store::GetPolicyStoreOutput::validation_settings): <p>The current validation settings for the policy store.</p>
12    ///   - [`created_date(DateTime)`](crate::operation::get_policy_store::GetPolicyStoreOutput::created_date): <p>The date and time that the policy store was originally created.</p>
13    ///   - [`last_updated_date(DateTime)`](crate::operation::get_policy_store::GetPolicyStoreOutput::last_updated_date): <p>The date and time that the policy store was last updated.</p>
14    ///   - [`description(Option<String>)`](crate::operation::get_policy_store::GetPolicyStoreOutput::description): <p>Descriptive text that you can provide to help with identification of the current policy store.</p>
15    ///   - [`deletion_protection(Option<DeletionProtection>)`](crate::operation::get_policy_store::GetPolicyStoreOutput::deletion_protection): <p>Specifies whether the policy store can be deleted. If enabled, the policy store can't be deleted.</p> <p>The default state is <code>DISABLED</code>.</p>
16    ///   - [`cedar_version(Option<CedarVersion>)`](crate::operation::get_policy_store::GetPolicyStoreOutput::cedar_version): <p>The version of the Cedar language used with policies, policy templates, and schemas in this policy store. For more information, see <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/userguide/cedar4-faq.html">Amazon Verified Permissions upgrade to Cedar v4 FAQ</a>.</p>
17    ///   - [`tags(Option<HashMap::<String, String>>)`](crate::operation::get_policy_store::GetPolicyStoreOutput::tags): <p>The list of tags associated with the policy store.</p>
18    /// - On failure, responds with [`SdkError<GetPolicyStoreError>`](crate::operation::get_policy_store::GetPolicyStoreError)
19    pub fn get_policy_store(&self) -> crate::operation::get_policy_store::builders::GetPolicyStoreFluentBuilder {
20        crate::operation::get_policy_store::builders::GetPolicyStoreFluentBuilder::new(self.handle.clone())
21    }
22}