AttachRolePolicyCommand

Use a bare-bones client and the command you need to make an API call.

To attach a managed policy to an IAM role

AttachRolePolicyCommandInput

[AttachRolePolicyCommandInput](@aws-sdk/client-iam!AttachRolePolicyCommandInput:Interface)

Attaches the specified managed policy to the specified IAM role. When you attach a managed policy to a role, the managed policy becomes part of the role's permission (access) policy. <note> You cannot use a managed policy as the role's trust policy. The role's trust policy is created at the same time as the role, using <a href="https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html"> <code>CreateRole</code> </a>. You can update a role's trust policy using <a href="https://docs.aws.amazon.com/IAM/latest/APIReference/API_UpdateAssumeRolePolicy.html"> <code>UpdateAssumerolePolicy</code> </a>. </note> Use this operation to attach a managed policy to a role. To embed an inline policy in a role, use <a href="https://docs.aws.amazon.com/IAM/latest/APIReference/API_PutRolePolicy.html"> <code>PutRolePolicy</code> </a>. For more information about policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed policies and inline policies</a> in the IAM User Guide. As a best practice, you can validate your IAM policies. To learn more, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_policy-validator.html">Validating IAM policies</a> in the IAM User Guide.

PolicyArn

The Amazon Resource Name (ARN) of the IAM policy you want to attach. For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the Amazon Web Services General Reference.

RoleName

The name (friendly name, not ARN) of the role to attach the policy to. 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: _+=,.-

The input for [AttachRolePolicyCommand](@aws-sdk/client-iam!AttachRolePolicyCommand:Class).

$metadata

AttachRolePolicyCommandOutput

The output of [AttachRolePolicyCommand](@aws-sdk/client-iam!AttachRolePolicyCommand:Class).

$fault

$response

$retryable

(constructor)

options

Constructs a new instance of the <code>ServiceException</code> class

[Symbol.hasInstance]

instance

Custom instanceof check to support the operator for ServiceException base class

isInstance

value

Checks if a value is an instance of ServiceException (duck typed)

name

InvalidInputException

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

LimitExceededException

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

NoSuchEntityException

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

PolicyNotAttachableException

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

ServiceFailureException

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

UnmodifiableEntityException

The request was rejected because service-linked roles are protected Amazon Web Services resources. Only the service that depends on the service-linked role can modify or delete the role on your behalf. The error message includes the name of the service that depends on this service-linked role. You must request the change through that service.

IAMServiceException

Base exception class for all service exceptions from IAM service.