Skip to content

update_role_description

Operation

update_role_description

update_role_description(request: UpdateRoleDescriptionInput | UpdateRoleDescriptionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateRoleDescriptionInputDict]) -> 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
request UpdateRoleDescriptionInput | UpdateRoleDescriptionInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[UpdateRoleDescriptionInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdateRoleDescriptionOutput

An instance of UpdateRoleDescriptionOutput.

update_role_description async

update_role_description(request: UpdateRoleDescriptionInput | UpdateRoleDescriptionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateRoleDescriptionInputDict]) -> 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
request UpdateRoleDescriptionInput | UpdateRoleDescriptionInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[UpdateRoleDescriptionInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdateRoleDescriptionOutput

An instance of UpdateRoleDescriptionOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

UpdateRoleDescriptionInputDict

Bases: TypedDict

Dictionary form of UpdateRoleDescriptionInput.

Attributes

description instance-attribute
description: Required[str]

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

role_name instance-attribute
role_name: Required[str]

The name of the role that you want to modify.

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.