Amazonka.IAM.UpdateRole

Updates the description or maximum session duration setting of a role.

Creating a Request

data UpdateRole

See: newUpdateRole smart constructor.

Constructors

UpdateRole'

Fields

• description :: Maybe Text

  The new description that you want to apply to the specified role.

• maxSessionDuration :: Maybe Natural

  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.

• roleName :: Text

  The name of the role that you want to modify.

Instances

ToHeaders UpdateRole

Defined in Amazonka.IAM.UpdateRole

Methods

toHeaders :: UpdateRole -> [Header]

ToPath UpdateRole

Defined in Amazonka.IAM.UpdateRole

Methods

toPath :: UpdateRole -> ByteString

ToQuery UpdateRole

Defined in Amazonka.IAM.UpdateRole

Methods

toQuery :: UpdateRole -> QueryString

AWSRequest UpdateRole

Defined in Amazonka.IAM.UpdateRole

Associated Types

type AWSResponse UpdateRole

Methods

request :: (Service -> Service) -> UpdateRole -> Request UpdateRole

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateRole -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateRole)))

Generic UpdateRole

Defined in Amazonka.IAM.UpdateRole

Associated Types

type Rep UpdateRole :: Type -> Type

Methods

from :: UpdateRole -> Rep UpdateRole x

to :: Rep UpdateRole x -> UpdateRole

Read UpdateRole

Defined in Amazonka.IAM.UpdateRole

Methods

readsPrec :: Int -> ReadS UpdateRole

readList :: ReadS [UpdateRole]

readPrec :: ReadPrec UpdateRole

readListPrec :: ReadPrec [UpdateRole]

Show UpdateRole

Defined in Amazonka.IAM.UpdateRole

Methods

showsPrec :: Int -> UpdateRole -> ShowS

show :: UpdateRole -> String

showList :: [UpdateRole] -> ShowS

NFData UpdateRole

Defined in Amazonka.IAM.UpdateRole

Methods

rnf :: UpdateRole -> ()

Eq UpdateRole

Defined in Amazonka.IAM.UpdateRole

Methods

(==) :: UpdateRole -> UpdateRole -> Bool

(/=) :: UpdateRole -> UpdateRole -> Bool

Hashable UpdateRole

Defined in Amazonka.IAM.UpdateRole

Methods

hashWithSalt :: Int -> UpdateRole -> Int

hash :: UpdateRole -> Int

type AWSResponse UpdateRole

Defined in Amazonka.IAM.UpdateRole

type AWSResponse UpdateRole = UpdateRoleResponse

type Rep UpdateRole

Defined in Amazonka.IAM.UpdateRole

type Rep UpdateRole = D1 ('MetaData "UpdateRole" "Amazonka.IAM.UpdateRole" "amazonka-iam-2.0-5DxkArXx9sD3CCYYGFyGET" 'False) (C1 ('MetaCons "UpdateRole'" 'PrefixI 'True) (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "maxSessionDuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "roleName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newUpdateRole

Arguments

:: Text

UpdateRole

-> UpdateRole

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:

UpdateRole, updateRole_description - The new description that you want to apply to the specified role.

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 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.

UpdateRole, updateRole_roleName - The name of the role that you want to modify.

Request Lenses

updateRole_description :: Lens' UpdateRole (Maybe Text)

The new description that you want to apply to the specified role.

updateRole_maxSessionDuration :: Lens' UpdateRole (Maybe Natural)

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.

updateRole_roleName :: Lens' UpdateRole Text

The name of the role that you want to modify.

Destructuring the Response

data UpdateRoleResponse

See: newUpdateRoleResponse smart constructor.

Constructors

UpdateRoleResponse'

Fields

• httpStatus :: Int

  The response's http status code.

Instances

Generic UpdateRoleResponse

Defined in Amazonka.IAM.UpdateRole

Associated Types

type Rep UpdateRoleResponse :: Type -> Type

Methods

from :: UpdateRoleResponse -> Rep UpdateRoleResponse x

to :: Rep UpdateRoleResponse x -> UpdateRoleResponse

Read UpdateRoleResponse

Defined in Amazonka.IAM.UpdateRole

Methods

readsPrec :: Int -> ReadS UpdateRoleResponse

readList :: ReadS [UpdateRoleResponse]

readPrec :: ReadPrec UpdateRoleResponse

readListPrec :: ReadPrec [UpdateRoleResponse]

Show UpdateRoleResponse

Defined in Amazonka.IAM.UpdateRole

Methods

showsPrec :: Int -> UpdateRoleResponse -> ShowS

show :: UpdateRoleResponse -> String

showList :: [UpdateRoleResponse] -> ShowS

NFData UpdateRoleResponse

Defined in Amazonka.IAM.UpdateRole

Methods

rnf :: UpdateRoleResponse -> ()

Eq UpdateRoleResponse

Defined in Amazonka.IAM.UpdateRole

Methods

(==) :: UpdateRoleResponse -> UpdateRoleResponse -> Bool

(/=) :: UpdateRoleResponse -> UpdateRoleResponse -> Bool

type Rep UpdateRoleResponse

Defined in Amazonka.IAM.UpdateRole

type Rep UpdateRoleResponse = D1 ('MetaData "UpdateRoleResponse" "Amazonka.IAM.UpdateRole" "amazonka-iam-2.0-5DxkArXx9sD3CCYYGFyGET" 'False) (C1 ('MetaCons "UpdateRoleResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateRoleResponse

Arguments

:: Int

$sel:httpStatus:UpdateRoleResponse'

-> UpdateRoleResponse

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

The response's http status code.