Qbusiness  >  Operations  >  get_group

get_group

Operation

get_group async

get_group(input: GetGroupInput, plugins: list[Plugin] | None = None) -> GetGroupOutput

Describes a group by group name.

Parameters:

Name	Type	Description	Default
input	GetGroupInput	An instance of GetGroupInput.	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
GetGroupOutput	An instance of GetGroupOutput.

Input

GetGroupInput dataclass

Dataclass for GetGroupInput structure.

Attributes

application_id class-attribute instance-attribute

application_id: str | None = None

The identifier of the application id the group is attached to.

data_source_id class-attribute instance-attribute

data_source_id: str | None = None

The identifier of the data source the group is attached to.

group_name class-attribute instance-attribute

group_name: str | None = None

The name of the group.

index_id class-attribute instance-attribute

index_id: str | None = None

The identifier of the index the group is attached to.

Output

GetGroupOutput dataclass

Dataclass for GetGroupOutput structure.

Attributes

status class-attribute instance-attribute

status: GroupStatusDetail | None = None

The current status of the group.

status_history class-attribute instance-attribute

status_history: list[GroupStatusDetail] | None = None

The status history of the group.