Skip to content

IAM  >  Operations  >  add_user_to_group

add_user_to_group

Operation

add_user_to_group async

add_user_to_group(request: AddUserToGroupInput | AddUserToGroupInputDict, /, *, plugins: list[Plugin] | None = None) -> AddUserToGroupOutput
add_user_to_group(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[AddUserToGroupInputDict]) -> AddUserToGroupOutput

Adds the specified user to the specified group.

Parameters:

Name Type Description Default
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
AddUserToGroupOutput

An instance of AddUserToGroupOutput.

Input

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

Model

AddUserToGroupInput dataclass

Bases: _SerdeShape

Dataclass for AddUserToGroupInput structure.

Attributes
group_name class-attribute instance-attribute
group_name: str | None = ...

The name of the group to update.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

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

The name of the user to add.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

Dictionaries

AddUserToGroupInputDict

Bases: TypedDict

Dictionary form of AddUserToGroupInput.

Attributes
group_name instance-attribute
group_name: Required[str]

The name of the group to update.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

user_name instance-attribute
user_name: Required[str]

The name of the user to add.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

Output

AddUserToGroupOutput dataclass

Bases: _SerdeShape

Dataclass for AddUserToGroupOutput 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.