Skip to content

ListServersRequest

Source code in docs_src/capo_migrationhubstrategy/types/list_servers_request.py
class ListServersRequest(TypedDict, closed=True):
    server_criteria: NotRequired[
        "capo_migrationhubstrategy.types.server_criteria.ServerCriteria"
    ]
    """<p> Criteria for filtering servers. </p>"""
    filter_value: NotRequired["capo_migrationhubstrategy.types.string.String"]
    """<p> Specifies the filter value, which is based on the type of server criteria. For example, if <code>serverCriteria</code> is <code>OS_NAME</code>, and the <code>filterValue</code> is equal to <code>WindowsServer</code>, then <code>ListServers</code> returns all of the servers matching the OS name <code>WindowsServer</code>. </p>"""
    sort: NotRequired["capo_migrationhubstrategy.types.sort_order.SortOrder"]
    """<p> Specifies whether to sort by ascending (<code>ASC</code>) or descending (<code>DESC</code>) order. </p>"""
    group_id_filter: NotRequired["capo_migrationhubstrategy.types.group_ids.GroupIds"]
    """<p> Specifies the group ID to filter on. </p>"""
    next_token: NotRequired["capo_migrationhubstrategy.types.next_token.NextToken"]
    """<p> The token from a previous call that you use to retrieve the next set of results. For example, if a previous call to this action returned 100 items, but you set <code>maxResults</code> to 10. You'll receive a set of 10 results along with a token. You then use the returned token to retrieve the next set of 10. </p>"""
    max_results: NotRequired["capo_migrationhubstrategy.types.max_result.MaxResult"]
    """<p> The maximum number of items to include in the response. The maximum value is 100. </p>"""

filter_value instance-attribute

filter_value: NotRequired[String]

Specifies the filter value, which is based on the type of server criteria. For example, if serverCriteria is OS_NAME, and the filterValue is equal to WindowsServer, then ListServers returns all of the servers matching the OS name WindowsServer.

group_id_filter instance-attribute

group_id_filter: NotRequired[GroupIds]

Specifies the group ID to filter on.

max_results instance-attribute

max_results: NotRequired[MaxResult]

The maximum number of items to include in the response. The maximum value is 100.

next_token instance-attribute

next_token: NotRequired[NextToken]

The token from a previous call that you use to retrieve the next set of results. For example, if a previous call to this action returned 100 items, but you set maxResults to 10. You'll receive a set of 10 results along with a token. You then use the returned token to retrieve the next set of 10.

server_criteria instance-attribute

server_criteria: NotRequired[ServerCriteria]

Criteria for filtering servers.

sort instance-attribute

sort: NotRequired[SortOrder]

Specifies whether to sort by ascending (ASC) or descending (DESC) order.