UpdateRole - Resource Access Management - Alibaba Cloud Documentation Center

Changes the description of a RAM role.

Operation description

This topic provides an example to show how to change the description of ECSAdmin to ECS administrator.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
ram:UpdateRole	Write	Role acs:ram:*:{#accountId}:role/{#RoleName}	ram:TrustedPrincipalTypes ram:ServiceNames	none

Request parameters

Parameter	Type	Required	Description	Example
RoleName	string	Yes	The name of the RAM role. The name must be 1 to 64 characters in length and can contain letters, digits, periods (.),and hyphens (-).	ECSAdmin
NewAssumeRolePolicyDocument	string	No	The policy that specifies the trusted entity to assume the RAM role.	{ "Statement": [ { "Action": "sts:AssumeRole", "Effect": "Allow", "Principal": { "RAM": "acs:ram::12345678901234****:root" } } ], "Version": "1" }
NewMaxSessionDuration	long	No	The maximum session duration of the RAM role. Valid values: 3600 to 43200. Unit: seconds.Default value: 3600. If you do not specify this parameter, the default value is used.	3600
NewDescription	string	No	The new description of the RAM role. The value must be 1 to 1,024 characters in length.	ECS administrator

For more information about common parameters, see Common parameters.

Response parameters

Parameter	Type	Description	Example
	object
Role	object	The information of the RAM role.
AssumeRolePolicyDocument	string	The policy that specifies the trusted entity to assume the RAM role.	{ "Statement": [ { "Action": "sts:AssumeRole", "Effect": "Allow", "Principal": { "RAM": "acs:ram::123456789012****:root" } } ], "Version": "1" }
UpdateDate	string	The time when the description of the RAM role was changed.	2015-01-23T12:33:18Z
Description	string	The description of the RAM role.	ECS administrator
MaxSessionDuration	long	The maximum session duration of the RAM role.	3600
RoleName	string	The name of the RAM role.	ECSAdmin
CreateDate	string	The time when the RAM role was created.	2015-01-23T12:33:18Z
RoleId	string	The ID of the RAM role.	901234567890****
Arn	string	The Alibaba Cloud Resource Name (ARN) of the role.	acs:ram::123456789012****:role/ECSAdmin
RequestId	string	The ID of the request.	04F0F334-1335-436C-A1D7-6C044FE73368

Examples

Sample success responses

JSONformat

{
  "Role": {
    "AssumeRolePolicyDocument": "{ \"Statement\": [ { \"Action\": \"sts:AssumeRole\", \"Effect\": \"Allow\", \"Principal\": { \"RAM\": \"acs:ram::123456789012****:root\" } } ], \"Version\": \"1\" }",
    "UpdateDate": "2015-01-23T12:33:18Z",
    "Description": "ECS administrator",
    "MaxSessionDuration": 3600,
    "RoleName": "ECSAdmin",
    "CreateDate": "2015-01-23T12:33:18Z",
    "RoleId": "901234567890****",
    "Arn": "acs:ram::123456789012****:role/ECSAdmin"
  },
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history