Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Updates the description or maximum session duration setting of a role.
Synopsis
- data UpdateRole = UpdateRole' {}
- newUpdateRole :: Text -> UpdateRole
- updateRole_maxSessionDuration :: Lens' UpdateRole (Maybe Natural)
- updateRole_description :: Lens' UpdateRole (Maybe Text)
- updateRole_roleName :: Lens' UpdateRole Text
- data UpdateRoleResponse = UpdateRoleResponse' {
- httpStatus :: Int
- newUpdateRoleResponse :: Int -> UpdateRoleResponse
- updateRoleResponse_httpStatus :: Lens' UpdateRoleResponse Int
Creating a Request
data UpdateRole Source #
See: newUpdateRole
smart constructor.
UpdateRole' | |
|
Instances
Create a value of UpdateRole
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxSessionDuration:UpdateRole'
, updateRole_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 maximum 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.
$sel:description:UpdateRole'
, updateRole_description
- The new description that you want to apply to the specified role.
$sel:roleName:UpdateRole'
, updateRole_roleName
- The name of the role that you want to modify.
Request Lenses
updateRole_maxSessionDuration :: Lens' UpdateRole (Maybe Natural) Source #
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 maximum 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.
updateRole_description :: Lens' UpdateRole (Maybe Text) Source #
The new description that you want to apply to the specified role.
updateRole_roleName :: Lens' UpdateRole Text Source #
The name of the role that you want to modify.
Destructuring the Response
data UpdateRoleResponse Source #
See: newUpdateRoleResponse
smart constructor.
UpdateRoleResponse' | |
|
Instances
newUpdateRoleResponse Source #
Create a value of UpdateRoleResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateRoleResponse'
, updateRoleResponse_httpStatus
- The response's http status code.
Response Lenses
updateRoleResponse_httpStatus :: Lens' UpdateRoleResponse Int Source #
The response's http status code.