aws iam update-role-description

Use UpdateRole instead. AWS CLI reference

1 example 2 options Its page in the AWS CLI reference

Examples

from aws-cli, each command read by CmdID

To change an IAM role's description

The following update-role-description example changes the description of the IAM role production-role to Main production role.

aws iam update-role-description --role-name production-role --description 'Main production role'Identify

--role-nameThe name of the role that you want to modify.

--descriptionThe new description that you want to apply to the specified role.

Its output

{
    "Role": {
        "Path": "/",
        "RoleName": "production-role",
        "RoleId": "AROA1234567890EXAMPLE",
        "Arn": "arn:aws:iam::123456789012:role/production-role",
        "CreateDate": "2017-12-06T17:16:37+00:00",
        "AssumeRolePolicyDocument": {
            "Version": "2012-10-17",
            "Statement": [
                {
                    "Effect": "Allow",
                    "Principal": {
                        "AWS": "arn:aws:iam::123456789012:root"
                    },
                    "Action": "sts:AssumeRole",
                    "Condition": {}
                }
            ]
        },
        "Description": "Main production role"
    }
}

For more information, see IAM role management in the AWS IAM User Guide.

Options

2 in the AWS CLI reference

--descriptionThe new description that you want to apply to the specified role.

--role-nameThe name of the role that you want to modify.