Skip to content

ListMembersRequest

Source code in docs_src/capo_securityhub/types/list_members_request.py 
13
14
15
16
17
18
19
20
21
class ListMembersRequest(TypedDict, closed=True):
    only_associated: NotRequired["capo_securityhub.types.boolean.Boolean"]
    """<p>Specifies which member accounts to include in the response based on their relationship status with the administrator account. The default value is <code>TRUE</code>.</p> <p>If <code>OnlyAssociated</code> is set to <code>TRUE</code>, the response includes member accounts whose relationship status with the administrator account is set to <code>ENABLED</code>.</p> <p>If <code>OnlyAssociated</code> is set to <code>FALSE</code>, the response includes all existing member accounts. </p>"""
    max_results: NotRequired[
        "capo_securityhub.types.cross_account_max_results.CrossAccountMaxResults"
    ]
    """<p>The maximum number of items to return in the response. </p>"""
    next_token: NotRequired["capo_securityhub.types.next_token.NextToken"]
    """<p>The token that is required for pagination. On your first call to the <code>ListMembers</code> operation, set the value of this parameter to <code>NULL</code>.</p> <p>For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.</p>"""

max_results instance-attribute 

max_results: NotRequired[CrossAccountMaxResults]

The maximum number of items to return in the response.

next_token instance-attribute 

next_token: NotRequired[NextToken]

The token that is required for pagination. On your first call to the ListMembers operation, set the value of this parameter to NULL.

For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.

only_associated instance-attribute 

only_associated: NotRequired[Boolean]

Specifies which member accounts to include in the response based on their relationship status with the administrator account. The default value is TRUE.

If OnlyAssociated is set to TRUE, the response includes member accounts whose relationship status with the administrator account is set to ENABLED.

If OnlyAssociated is set to FALSE, the response includes all existing member accounts.