list_groups¶
Operation¶
list_groups
¶
list_groups(request: ListGroupsInput | ListGroupsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListGroupsInputDict]) -> ListGroupsOutput
Provides a list of groups that are mapped to users.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ListGroupsInput | ListGroupsInputDict | 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[ListGroupsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListGroupsOutput
|
An instance of |
list_groups
async
¶
list_groups(request: ListGroupsInput | ListGroupsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListGroupsInputDict]) -> ListGroupsOutput
Provides a list of groups that are mapped to users.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ListGroupsInput | ListGroupsInputDict | 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[ListGroupsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListGroupsOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
ListGroupsInputDict
¶
Bases: TypedDict
Dictionary form of ListGroupsInput.
Attributes¶
application_id
instance-attribute
¶
The identifier of the application for getting a list of groups mapped to users.
data_source_id
instance-attribute
¶
data_source_id: str | None
The identifier of the data source for getting a list of groups mapped to users.
index_id
instance-attribute
¶
The identifier of the index for getting a list of groups mapped to users.
max_results
instance-attribute
¶
max_results: int | None
The maximum number of returned groups that are mapped to users.
ListGroupsInput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListGroupsInput structure.
Attributes¶
application_id
class-attribute
instance-attribute
¶
application_id: str | None = ...
The identifier of the application for getting a list of groups mapped to users.
data_source_id
class-attribute
instance-attribute
¶
data_source_id: str | None = ...
The identifier of the data source for getting a list of groups mapped to users.
index_id
class-attribute
instance-attribute
¶
index_id: str | None = ...
The identifier of the index for getting a list of groups mapped to users.
max_results
class-attribute
instance-attribute
¶
max_results: int | None = ...
The maximum number of returned groups that are mapped to users.
next_token
class-attribute
instance-attribute
¶
next_token: str | None = ...
If the previous response was incomplete (because there is more data to retrieve), Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of groups that are mapped to users.
Output¶
ListGroupsOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListGroupsOutput structure.
Attributes¶
items
class-attribute
instance-attribute
¶
items: list[GroupSummary] | None = ...
Summary information for list of groups that are mapped to users.
next_token
class-attribute
instance-attribute
¶
next_token: str | None = ...
If the response is truncated, Amazon Q Business returns this token that you can use in the subsequent request to retrieve the next set of groups that are mapped to users.
response_metadata
class-attribute
instance-attribute
¶
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.