Skip to content

ListAgreementsRequest

Source code in docs_src/capo_transfer/types/list_agreements_request.py 
15
16
17
18
19
20
21
class ListAgreementsRequest(TypedDict, closed=True):
    max_results: NotRequired["capo_transfer.types.max_results.MaxResults"]
    """<p>The maximum number of items to return.</p>"""
    next_token: NotRequired["capo_transfer.types.next_token.NextToken"]
    """<p>When you can get additional results from the <code>ListAgreements</code> call, a <code>NextToken</code> parameter is returned in the output. You can then pass in a subsequent command to the <code>NextToken</code> parameter to continue listing additional agreements.</p>"""
    server_id: "capo_transfer.types.server_id.ServerId"
    """<p>The identifier of the server for which you want a list of agreements.</p>"""

max_results instance-attribute 

max_results: NotRequired[MaxResults]

The maximum number of items to return.

next_token instance-attribute 

next_token: NotRequired[NextToken]

When you can get additional results from the ListAgreements call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional agreements.

server_id instance-attribute 

server_id: ServerId

The identifier of the server for which you want a list of agreements.