libZSservicesZSamazonka-iamZSamazonka-iam
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.IAM.UpdateRole

Description

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

Synopsis

Creating a Request

data UpdateRole Source #

See: newUpdateRole smart constructor.

Constructors

UpdateRole' 

Fields

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

  • description :: Maybe Text

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

  • roleName :: Text

    The name of the role that you want to modify.

Instances

Instances details
Eq UpdateRole Source # 
Instance details

Defined in Amazonka.IAM.UpdateRole

Read UpdateRole Source # 
Instance details

Defined in Amazonka.IAM.UpdateRole

Show UpdateRole Source # 
Instance details

Defined in Amazonka.IAM.UpdateRole

Generic UpdateRole Source # 
Instance details

Defined in Amazonka.IAM.UpdateRole

Associated Types

type Rep UpdateRole :: Type -> Type #

NFData UpdateRole Source # 
Instance details

Defined in Amazonka.IAM.UpdateRole

Methods

rnf :: UpdateRole -> () #

Hashable UpdateRole Source # 
Instance details

Defined in Amazonka.IAM.UpdateRole

AWSRequest UpdateRole Source # 
Instance details

Defined in Amazonka.IAM.UpdateRole

Associated Types

type AWSResponse UpdateRole #

ToHeaders UpdateRole Source # 
Instance details

Defined in Amazonka.IAM.UpdateRole

Methods

toHeaders :: UpdateRole -> [Header] #

ToPath UpdateRole Source # 
Instance details

Defined in Amazonka.IAM.UpdateRole

ToQuery UpdateRole Source # 
Instance details

Defined in Amazonka.IAM.UpdateRole

type Rep UpdateRole Source # 
Instance details

Defined in Amazonka.IAM.UpdateRole

type Rep UpdateRole = D1 ('MetaData "UpdateRole" "Amazonka.IAM.UpdateRole" "libZSservicesZSamazonka-iamZSamazonka-iam" 'False) (C1 ('MetaCons "UpdateRole'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxSessionDuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "roleName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse UpdateRole Source # 
Instance details

Defined in Amazonka.IAM.UpdateRole

newUpdateRole Source #

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.

Constructors

UpdateRoleResponse' 

Fields

Instances

Instances details
Eq UpdateRoleResponse Source # 
Instance details

Defined in Amazonka.IAM.UpdateRole

Read UpdateRoleResponse Source # 
Instance details

Defined in Amazonka.IAM.UpdateRole

Show UpdateRoleResponse Source # 
Instance details

Defined in Amazonka.IAM.UpdateRole

Generic UpdateRoleResponse Source # 
Instance details

Defined in Amazonka.IAM.UpdateRole

Associated Types

type Rep UpdateRoleResponse :: Type -> Type #

NFData UpdateRoleResponse Source # 
Instance details

Defined in Amazonka.IAM.UpdateRole

Methods

rnf :: UpdateRoleResponse -> () #

type Rep UpdateRoleResponse Source # 
Instance details

Defined in Amazonka.IAM.UpdateRole

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

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