AttachGroupPolicy - AWS Identity and Access Management

AttachGroupPolicy

Attaches the specified managed policy to the specified IAM group.

You use this operation to attach a managed policy to a group. To embed an inline policy in a group, use PutGroupPolicy.

As a best practice, you can validate your IAM policies. To learn more, see Validating IAM policies in the IAM User Guide.

For more information about policies, see Managed policies and inline policies in the IAM User Guide.

Request Syntax

{ "GroupName": "string", "PolicyArn": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

GroupName

The name (friendly name, not ARN) of the group to attach the policy to.

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

PolicyArn

The Amazon Resource Name (ARN) of the IAM policy you want to attach.

For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidInputException

The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

HTTP Status Code: 400

LimitExceededException

The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.

HTTP Status Code: 400

NoSuchEntityException

The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.

HTTP Status Code: 400

PolicyNotAttachableException

The request failed because AWS service role policies can only be attached to the service-linked role for that service.

HTTP Status Code: 400

ServiceFailureException

The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of AttachGroupPolicy.

Sample Request

https://iam.amazonaws.com/?Action=AttachGroupPolicy &GroupName=Finance &PolicyArn=arn:aws:iam::aws:policy/ReadOnlyAccess &Version=2010-05-08 &AUTHPARAMS

Sample Response

<AttachGroupPolicyResponse xmlns="https://iam.amazonaws.com/doc/2010-05-08/"> <ResponseMetadata> <RequestId>f8a7b7b9-3d01-11e4-bfad-8d1c6EXAMPLE</RequestId> </ResponseMetadata> </AttachGroupPolicyResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: