Skip to content

ListGroupsResponse

Source code in docs_src/capo_iam/types/list_groups_response.py
class ListGroupsResponse(TypedDict, closed=True):
    groups: "capo_iam.types.group_list_type.groupListType"
    """<p>A list of groups.</p>"""
    is_truncated: "capo_iam.types.boolean_type.booleanType"
    """<p>A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the <code>Marker</code> request parameter to retrieve more items. Note that IAM might return fewer than the <code>MaxItems</code> number of results even when there are more results available. We recommend that you check <code>IsTruncated</code> after every call to ensure that you receive all your results.</p>"""
    marker: NotRequired["capo_iam.types.response_marker_type.responseMarkerType"]
    """<p>When <code>IsTruncated</code> is <code>true</code>, this element is present and contains the value to use for the <code>Marker</code> parameter in a subsequent pagination request.</p>"""

groups instance-attribute

groups: groupListType

A list of groups.

is_truncated instance-attribute

is_truncated: booleanType

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

marker instance-attribute

marker: NotRequired[responseMarkerType]

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.