amazonka-iam-2.0: Amazon Identity and Access Management SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.IAM.UpdateRoleDescription

Description

Use UpdateRole instead.

Modifies only the description of a role. This operation performs the same function as the Description parameter in the UpdateRole operation.

Synopsis

Creating a Request

data UpdateRoleDescription Source #

See: newUpdateRoleDescription smart constructor.

Constructors

UpdateRoleDescription' 

Fields

  • roleName :: Text

    The name of the role that you want to modify.

  • description :: Text

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

Instances

Instances details
ToHeaders UpdateRoleDescription Source # 
Instance details

Defined in Amazonka.IAM.UpdateRoleDescription

Methods

toHeaders :: UpdateRoleDescription -> [Header] #

ToPath UpdateRoleDescription Source # 
Instance details

Defined in Amazonka.IAM.UpdateRoleDescription

Methods

toPath :: UpdateRoleDescription -> ByteString #

ToQuery UpdateRoleDescription Source # 
Instance details

Defined in Amazonka.IAM.UpdateRoleDescription

Methods

toQuery :: UpdateRoleDescription -> QueryString #

AWSRequest UpdateRoleDescription Source # 
Instance details

Defined in Amazonka.IAM.UpdateRoleDescription

Associated Types

type AWSResponse UpdateRoleDescription #

Methods

request :: (Service -> Service) -> UpdateRoleDescription -> Request UpdateRoleDescription #

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

Generic UpdateRoleDescription Source # 
Instance details

Defined in Amazonka.IAM.UpdateRoleDescription

Associated Types

type Rep UpdateRoleDescription :: Type -> Type #

Methods

from :: UpdateRoleDescription -> Rep UpdateRoleDescription x #

to :: Rep UpdateRoleDescription x -> UpdateRoleDescription #

Read UpdateRoleDescription Source # 
Instance details

Defined in Amazonka.IAM.UpdateRoleDescription

Methods

readsPrec :: Int -> ReadS UpdateRoleDescription #

readList :: ReadS [UpdateRoleDescription] #

readPrec :: ReadPrec UpdateRoleDescription #

readListPrec :: ReadPrec [UpdateRoleDescription] #

Show UpdateRoleDescription Source # 
Instance details

Defined in Amazonka.IAM.UpdateRoleDescription

Methods

showsPrec :: Int -> UpdateRoleDescription -> ShowS #

show :: UpdateRoleDescription -> String #

showList :: [UpdateRoleDescription] -> ShowS #

NFData UpdateRoleDescription Source # 
Instance details

Defined in Amazonka.IAM.UpdateRoleDescription

Methods

rnf :: UpdateRoleDescription -> () #

Eq UpdateRoleDescription Source # 
Instance details

Defined in Amazonka.IAM.UpdateRoleDescription

Methods

(==) :: UpdateRoleDescription -> UpdateRoleDescription -> Bool #

(/=) :: UpdateRoleDescription -> UpdateRoleDescription -> Bool #

Hashable UpdateRoleDescription Source # 
Instance details

Defined in Amazonka.IAM.UpdateRoleDescription

Methods

hashWithSalt :: Int -> UpdateRoleDescription -> Int #

hash :: UpdateRoleDescription -> Int #

type AWSResponse UpdateRoleDescription Source # 
Instance details

Defined in Amazonka.IAM.UpdateRoleDescription

type AWSResponse UpdateRoleDescription = UpdateRoleDescriptionResponse
type Rep UpdateRoleDescription Source # 
Instance details

Defined in Amazonka.IAM.UpdateRoleDescription

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

newUpdateRoleDescription Source #

Arguments

:: Text

UpdateRoleDescription

-> Text

UpdateRoleDescription

-> UpdateRoleDescription 

Create a value of UpdateRoleDescription 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:

UpdateRoleDescription, updateRoleDescription_roleName - The name of the role that you want to modify.

UpdateRoleDescription, updateRoleDescription_description - The new description that you want to apply to the specified role.

Request Lenses

updateRoleDescription_roleName :: Lens' UpdateRoleDescription Text Source #

The name of the role that you want to modify.

updateRoleDescription_description :: Lens' UpdateRoleDescription Text Source #

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

Destructuring the Response

data UpdateRoleDescriptionResponse Source #

See: newUpdateRoleDescriptionResponse smart constructor.

Constructors

UpdateRoleDescriptionResponse' 

Fields

Instances

Instances details
Generic UpdateRoleDescriptionResponse Source # 
Instance details

Defined in Amazonka.IAM.UpdateRoleDescription

Associated Types

type Rep UpdateRoleDescriptionResponse :: Type -> Type #

Methods

from :: UpdateRoleDescriptionResponse -> Rep UpdateRoleDescriptionResponse x #

to :: Rep UpdateRoleDescriptionResponse x -> UpdateRoleDescriptionResponse #

Read UpdateRoleDescriptionResponse Source # 
Instance details

Defined in Amazonka.IAM.UpdateRoleDescription

Methods

readsPrec :: Int -> ReadS UpdateRoleDescriptionResponse #

readList :: ReadS [UpdateRoleDescriptionResponse] #

readPrec :: ReadPrec UpdateRoleDescriptionResponse #

readListPrec :: ReadPrec [UpdateRoleDescriptionResponse] #

Show UpdateRoleDescriptionResponse Source # 
Instance details

Defined in Amazonka.IAM.UpdateRoleDescription

Methods

showsPrec :: Int -> UpdateRoleDescriptionResponse -> ShowS #

show :: UpdateRoleDescriptionResponse -> String #

showList :: [UpdateRoleDescriptionResponse] -> ShowS #

NFData UpdateRoleDescriptionResponse Source # 
Instance details

Defined in Amazonka.IAM.UpdateRoleDescription

Methods

rnf :: UpdateRoleDescriptionResponse -> () #

Eq UpdateRoleDescriptionResponse Source # 
Instance details

Defined in Amazonka.IAM.UpdateRoleDescription

Methods

(==) :: UpdateRoleDescriptionResponse -> UpdateRoleDescriptionResponse -> Bool #

(/=) :: UpdateRoleDescriptionResponse -> UpdateRoleDescriptionResponse -> Bool #

type Rep UpdateRoleDescriptionResponse Source # 
Instance details

Defined in Amazonka.IAM.UpdateRoleDescription

type Rep UpdateRoleDescriptionResponse = D1 ('MetaData "UpdateRoleDescriptionResponse" "Amazonka.IAM.UpdateRoleDescription" "amazonka-iam-2.0-5DxkArXx9sD3CCYYGFyGET" 'False) (C1 ('MetaCons "UpdateRoleDescriptionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "role'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Role)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateRoleDescriptionResponse Source #

Arguments

:: Int

$sel:httpStatus:UpdateRoleDescriptionResponse'

-> UpdateRoleDescriptionResponse 

Create a value of UpdateRoleDescriptionResponse 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:role':UpdateRoleDescriptionResponse', updateRoleDescriptionResponse_role - A structure that contains details about the modified role.

$sel:httpStatus:UpdateRoleDescriptionResponse', updateRoleDescriptionResponse_httpStatus - The response's http status code.

Response Lenses

updateRoleDescriptionResponse_role :: Lens' UpdateRoleDescriptionResponse (Maybe Role) Source #

A structure that contains details about the modified role.

updateRoleDescriptionResponse_httpStatus :: Lens' UpdateRoleDescriptionResponse Int Source #

The response's http status code.