Skip to content

get_group

Operation

get_group

get_group(request: GetGroupInput | GetGroupInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetGroupInputDict]) -> GetGroupOutput

Describes a group by group name.

Parameters:

Name Type Description Default
request GetGroupInput | GetGroupInputDict | 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[GetGroupInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetGroupOutput

An instance of GetGroupOutput.

get_group async

get_group(request: GetGroupInput | GetGroupInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetGroupInputDict]) -> GetGroupOutput

Describes a group by group name.

Parameters:

Name Type Description Default
request GetGroupInput | GetGroupInputDict | 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[GetGroupInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetGroupOutput

An instance of GetGroupOutput.

Input

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

GetGroupInputDict

Bases: TypedDict

Dictionary form of GetGroupInput.

Attributes

application_id instance-attribute
application_id: Required[str]

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

data_source_id instance-attribute
data_source_id: str | None

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

group_name instance-attribute
group_name: Required[str]

The name of the group.

index_id instance-attribute
index_id: Required[str]

The identifier of the index the group is attached to.

GetGroupInput dataclass

Bases: _SerdeShape

Dataclass for GetGroupInput structure.

Attributes

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

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

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

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

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

The name of the group.

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

The identifier of the index the group is attached to.

Output

GetGroupOutput dataclass

Bases: _SerdeShape

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

status class-attribute instance-attribute
status: GroupStatusDetail | None = ...

The current status of the group.

status_history class-attribute instance-attribute
status_history: list[GroupStatusDetail] | None = ...

The status history of the group.