UpdateRoleDescription
Use UpdateRole instead.
Modifies only the description of a role. This operation performs the same function as
the Description parameter in the UpdateRole operation.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- Description
-
The new description that you want to apply to the specified role.
Type: String
Length Constraints: Maximum length of 1000.
Pattern:
[\u0009\u000A\u000D\u0020-\u007E\u00A1-\u00FF]*Required: Yes
- RoleName
-
The name of the role that you want to modify.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[\w+=,.@-]+Required: Yes
Response Elements
The following element is returned by the service.
- Role
-
A structure that contains details about the modified role.
Type: Role object
Errors
For information about the errors that are common to all actions, see Common Errors.
- NoSuchEntity
-
The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
HTTP Status Code: 404
- ServiceFailure
-
The request processing has failed because of an unknown error, exception or failure.
HTTP Status Code: 500
- UnmodifiableEntity
-
The request was rejected because service-linked roles are protected AWS 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.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
