Skip to content

ListFarmsRequest

Source code in docs_src/capo_deadline/types/list_farms_request.py
class ListFarmsRequest(TypedDict, closed=True):
    next_token: NotRequired["capo_deadline.types.next_token.NextToken"]
    """<p>The token for the next set of results, or <code>null</code> to start from the beginning.</p>"""
    max_results: "capo_deadline.types.max_results.MaxResults"
    """<p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages.</p>"""
    principal_id: NotRequired[
        "capo_deadline.types.identity_center_principal_id.IdentityCenterPrincipalId"
    ]
    """<p>The principal ID of the member to list on the farm.</p>"""

max_results instance-attribute

max_results: MaxResults

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

next_token instance-attribute

next_token: NotRequired[NextToken]

The token for the next set of results, or null to start from the beginning.

principal_id instance-attribute

principal_id: NotRequired[IdentityCenterPrincipalId]

The principal ID of the member to list on the farm.