UpdateRole
Updates the description or maximum session duration setting of a role.
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: No
- MaxSessionDuration
-
The maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a value for this setting, the default value of one hour is applied. This setting can have a value from 1 hour to 12 hours.
Anyone who assumes the role from the Amazon CLI or API can use the
DurationSeconds
API parameter or theduration-seconds
Amazon CLI parameter to request a longer session. TheMaxSessionDuration
setting determines the maximum duration that can be requested using theDurationSeconds
parameter. If users don't specify a value for theDurationSeconds
parameter, their security credentials are valid for one hour by default. This applies when you use theAssumeRole*
API operations or theassume-role*
Amazon CLI operations but does not apply when you use those operations to create a console URL. For more information, see Using IAM roles in the IAM User Guide.Type: Integer
Valid Range: Minimum value of 3600. Maximum value of 43200.
Required: No
- 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
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 Amazon 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 Amazon SDKs, see the following: