GetGroupPolicy
Retrieves the specified inline policy document that is embedded in the specified IAM group.
Note
Policies returned by this operation are URL-encoded compliant
with RFC 3986decode method of the java.net.URLDecoder utility class in
the Java SDK. Other languages and SDKs provide similar functionality, and some SDKs do this decoding
automatically.
An IAM group can also have managed policies attached to it. To retrieve a managed policy document that is attached to a group, use GetPolicy to determine the policy's default version, then use GetPolicyVersion to retrieve the policy document.
For more information about policies, see Managed policies and inline policies in the IAM User Guide.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- GroupName
-
The name of the group the policy is associated with.
This parameter allows (through its regex pattern
) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[\w+=,.@-]+Required: Yes
- PolicyName
-
The name of the policy document to get.
This parameter allows (through its regex pattern
) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[\w+=,.@-]+Required: Yes
Response Elements
The following elements are returned by the service.
- GroupName
-
The group the policy is associated with.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[\w+=,.@-]+ - PolicyDocument
-
The policy document.
IAM stores policies in JSON format. However, resources that were created using AWS CloudFormation templates can be formatted in YAML. AWS CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 131072.
Pattern:
[\u0009\u000A\u000D\u0020-\u00FF]+ - PolicyName
-
The name of the policy.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[\w+=,.@-]+
Errors
For information about the errors that are common to all actions, see Common Errors.
- NoSuchEntity
-
The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
HTTP Status Code: 404
- ServiceFailure
-
The request processing has failed because of an unknown error, exception or failure.
HTTP Status Code: 500
Examples
Example
This example illustrates one usage of GetGroupPolicy.
Sample Request
https://iam.amazonaws.com/?Action=GetGroupPolicy
&GroupName=Admins
&PolicyName=AdminRoot
&AUTHPARAMSSample Response
<GetGroupPolicyResponse xmlns="https://iam.amazonaws.com/doc/2010-05-08/">
<GetGroupPolicyResult>
<GroupName>Admins</GroupName>
<PolicyName>AdminRoot</PolicyName>
<PolicyDocument>
{"Version":"2012-10-17","Statement":{"Effect":"Allow","Action":"*","Resource":"*"}}
</PolicyDocument>
</GetGroupPolicyResult>
<ResponseMetadata>
<RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId>
</ResponseMetadata>
</GetGroupPolicyResponse>See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
