Skip to content

ListFleetsRequest

Source code in docs_src/capo_deadline/types/list_fleets_request.py
class ListFleetsRequest(TypedDict, closed=True):
    farm_id: "capo_deadline.types.farm_id.FarmId"
    """<p>The farm ID of the fleets.</p>"""
    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 members to include in the fleet.</p>"""
    display_name: NotRequired["capo_deadline.types.resource_name.ResourceName"]
    """<p>The display names of a list of fleets.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>"""
    status: NotRequired["capo_deadline.types.fleet_status.FleetStatus"]
    """<p>The status of the fleet.</p>"""

display_name instance-attribute

display_name: NotRequired[ResourceName]

The display names of a list of fleets.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

farm_id instance-attribute

farm_id: FarmId

The farm ID of the fleets.

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 members to include in the fleet.

status instance-attribute

status: NotRequired[FleetStatus]

The status of the fleet.