Skip to content

delete_group

Operation

delete_group

delete_group(request: DeleteGroupInput | DeleteGroupInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteGroupInputDict]) -> DeleteGroupOutput

Deletes the specified IAM group. The group must not contain any users or have any attached policies.

Parameters:

Name Type Description Default
request DeleteGroupInput | DeleteGroupInputDict | 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[DeleteGroupInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteGroupOutput

An instance of DeleteGroupOutput.

delete_group async

delete_group(request: DeleteGroupInput | DeleteGroupInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteGroupInputDict]) -> DeleteGroupOutput

Deletes the specified IAM group. The group must not contain any users or have any attached policies.

Parameters:

Name Type Description Default
request DeleteGroupInput | DeleteGroupInputDict | 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[DeleteGroupInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteGroupOutput

An instance of DeleteGroupOutput.

Input

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

DeleteGroupInputDict

Bases: TypedDict

Dictionary form of DeleteGroupInput.

Attributes

group_name instance-attribute
group_name: Required[str]

The name of the IAM group to delete.

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: _+=,.@-

DeleteGroupInput dataclass

Bases: _SerdeShape

Dataclass for DeleteGroupInput structure.

Attributes

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

The name of the IAM group to delete.

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

DeleteGroupOutput dataclass

Bases: _SerdeShape

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