list_key_groups¶
Operation¶
list_key_groups
¶
list_key_groups(request: ListKeyGroupsInput | ListKeyGroupsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListKeyGroupsInputDict]) -> 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 |
|---|---|---|---|
request
|
ListKeyGroupsInput | ListKeyGroupsInputDict | 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[ListKeyGroupsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListKeyGroupsOutput
|
An instance of |
list_key_groups
async
¶
list_key_groups(request: ListKeyGroupsInput | ListKeyGroupsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListKeyGroupsInputDict]) -> 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 |
|---|---|---|---|
request
|
ListKeyGroupsInput | ListKeyGroupsInputDict | 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[ListKeyGroupsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListKeyGroupsOutput
|
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.
ListKeyGroupsInputDict
¶
Bases: TypedDict
Dictionary form of ListKeyGroupsInput.
Attributes¶
marker
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.
ListKeyGroupsInput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListKeyGroupsInput structure.
Attributes¶
marker
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¶
ListKeyGroupsOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListKeyGroupsOutput structure.
Attributes¶
key_group_list
class-attribute
instance-attribute
¶
key_group_list: KeyGroupList | None = ...
A list of key groups.
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.