Modify information about a RAM role - Resource Access Management - Alibaba Cloud - Resource Access Management

Operation description

This example shows how to update the description of the RAM role ECSAdmin to ECS management role.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ram:UpdateRole

update

*Role

acs:ram:*:{#accountId}:role/{#RoleName}

ram:TrustedPrincipalTypes
ram:ServiceNames

None

Request parameters

Parameter	Type	Required	Description	Example
RoleName	string	No	The name of the RAM role. The name must be 1 to 64 characters long and can contain letters, digits, periods (.), and hyphens (-).	ECSAdmin
NewAssumeRolePolicyDocument	string	No	The trust policy of the RAM role.	{ "Statement": [ { "Action": "sts:AssumeRole", "Effect": "Allow", "Principal": { "RAM": "acs:ram::12345678901234****:root" } } ], "Version": "1" }
NewMaxSessionDuration	integer	No	The maximum session duration of the RAM role, in seconds. Valid values: 3600 to 43200. The default value is 3600.	3600
NewDescription	string	No	The new description of the RAM role. The description must be 1 to 1,024 characters long.	ECS management role

For information about common parameters, see Common parameters.

Response elements

Element	Type	Description	Example
	object	The data returned.
Role	object	The details of the RAM role.
AssumeRolePolicyDocument	string	The trust policy of the RAM role.	{ "Statement": [ { "Action": "sts:AssumeRole", "Effect": "Allow", "Principal": { "RAM": "acs:ram::123456789012****:root" } } ], "Version": "1" }
UpdateDate	string	The time the RAM role was last updated.	2015-01-23T12:33:18Z
Description	string	The description of the RAM role.	ECS management role
MaxSessionDuration	integer	The maximum session duration of the RAM role.	3600
RoleName	string	The name of the RAM role.	ECSAdmin
CreateDate	string	The time 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 RAM role.	acs:ram::123456789012****:role/ECSAdmin
RequestId	string	The request ID.	04F0F334-1335-436C-A1D7-6C044FE73368

Examples

Success response

JSON format

{
  "Role": {
    "AssumeRolePolicyDocument": "{ \"Statement\": [ { \"Action\": \"sts:AssumeRole\", \"Effect\": \"Allow\", \"Principal\": { \"RAM\": \"acs:ram::123456789012****:root\" } } ], \"Version\": \"1\" }",
    "UpdateDate": "2015-01-23T12:33:18Z",
    "Description": "ECS management role",
    "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.