update_role¶
Operation¶
async
¶
update_role(input: UpdateRoleInput, plugins: list[Plugin] | None = None) -> UpdateRoleOutput
Updates the description or maximum session duration setting of a role.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
UpdateRoleInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
UpdateRoleOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateRoleInput structure.
Attributes¶
class-attribute
instance-attribute
¶
description: str | None = ...
The new description that you want to apply to the specified role.
class-attribute
instance-attribute
¶
max_session_duration: int | None = ...
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 CLI or API can use the
DurationSeconds API parameter or the duration-seconds CLI parameter
to request a longer session. The MaxSessionDuration setting determines
the maximum duration that can be requested using the DurationSeconds
parameter. If users don't specify a value for the DurationSeconds
parameter, their security credentials are valid for one hour by default.
This applies when you use the AssumeRole* API operations or the
assume-role* 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.
Note
IAM role credentials provided by Amazon EC2 instances assigned to the role are not subject to the specified maximum session duration.
Output¶
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateRoleOutput structure.