list_key_groups¶
Operation¶
async
¶
list_key_groups(input: ListKeyGroupsInput, plugins: list[Plugin] | None = None) -> ListKeyGroupsOutput
Gets a list of key groups.
You can optionally specify the maximum number of items to receive in the
response. If the total number of items in the list exceeds the maximum
that you specify, or the default maximum, the response is paginated. To
get the next page of items, send a subsequent request that specifies the
NextMarker value from the current response as the Marker value in
the subsequent request.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ListKeyGroupsInput
|
An instance of |
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 |
|---|---|
ListKeyGroupsOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Dataclass for ListKeyGroupsInput structure.
Attributes¶
class-attribute
instance-attribute
¶
marker: str | None = ...
Use this field when paginating results to indicate where to begin in
your list of key groups. The response includes key groups in the list
that occur after the marker. To get the next page of the list, set this
field's value to the value of NextMarker from the current page's
response.
Output¶
dataclass
¶
Bases: _SerdeShape
Dataclass for ListKeyGroupsOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
A list of key groups.
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.