aws_sdk_iam/client/get_group_policy.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 [`GetGroupPolicy`](crate::operation::get_group_policy::builders::GetGroupPolicyFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`group_name(impl Into<String>)`](crate::operation::get_group_policy::builders::GetGroupPolicyFluentBuilder::group_name) / [`set_group_name(Option<String>)`](crate::operation::get_group_policy::builders::GetGroupPolicyFluentBuilder::set_group_name):<br>required: **true**<br><p>The name of the group the policy is associated with.</p> <p>This parameter allows (through its <a href="http://wikipedia.org/wiki/regex">regex pattern</a>) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-</p><br>
7 /// - [`policy_name(impl Into<String>)`](crate::operation::get_group_policy::builders::GetGroupPolicyFluentBuilder::policy_name) / [`set_policy_name(Option<String>)`](crate::operation::get_group_policy::builders::GetGroupPolicyFluentBuilder::set_policy_name):<br>required: **true**<br><p>The name of the policy document to get.</p> <p>This parameter allows (through its <a href="http://wikipedia.org/wiki/regex">regex pattern</a>) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-</p><br>
8 /// - On success, responds with [`GetGroupPolicyOutput`](crate::operation::get_group_policy::GetGroupPolicyOutput) with field(s):
9 /// - [`group_name(String)`](crate::operation::get_group_policy::GetGroupPolicyOutput::group_name): <p>The group the policy is associated with.</p>
10 /// - [`policy_name(String)`](crate::operation::get_group_policy::GetGroupPolicyOutput::policy_name): <p>The name of the policy.</p>
11 /// - [`policy_document(String)`](crate::operation::get_group_policy::GetGroupPolicyOutput::policy_document): <p>The policy document.</p> <p>IAM stores policies in JSON format. However, resources that were created using CloudFormation templates can be formatted in YAML. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.</p>
12 /// - On failure, responds with [`SdkError<GetGroupPolicyError>`](crate::operation::get_group_policy::GetGroupPolicyError)
13 pub fn get_group_policy(&self) -> crate::operation::get_group_policy::builders::GetGroupPolicyFluentBuilder {
14 crate::operation::get_group_policy::builders::GetGroupPolicyFluentBuilder::new(self.handle.clone())
15 }
16}