Skip to content

IAM  >  Operations  >  update_role_description

update_role_description

Operation

update_role_description async 

update_role_description(input: UpdateRoleDescriptionInput, plugins: list[Plugin] | None = None) -> UpdateRoleDescriptionOutput

Use UpdateRole instead.

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

Parameters:

Name Type Description Default
input UpdateRoleDescriptionInput

An instance of UpdateRoleDescriptionInput.

 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
UpdateRoleDescriptionOutput

An instance of UpdateRoleDescriptionOutput.

Input

UpdateRoleDescriptionInput dataclass

Bases: _SerdeShape

Dataclass for UpdateRoleDescriptionInput structure.

Attributes

description class-attribute instance-attribute 
description: str | None = ...

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

role_name class-attribute instance-attribute 
role_name: str | None = ...

The name of the role that you want to modify.

Output

UpdateRoleDescriptionOutput dataclass

Bases: _SerdeShape

Dataclass for UpdateRoleDescriptionOutput structure.

Attributes

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

role class-attribute instance-attribute 
role: Role | None = ...

A structure that contains details about the modified role.