Skip to content

ListEnvironmentsRequest

Source code in docs_src/capo_evs/types/list_environments_request.py 
13
14
15
16
17
18
19
class ListEnvironmentsRequest(TypedDict, closed=True):
    next_token: NotRequired["capo_evs.types.pagination_token.PaginationToken"]
    """<p>A unique pagination token for each page. If <code>nextToken</code> is returned, there are more results available. Make the call again using the returned token with all other arguments unchanged to retrieve the next page. Each pagination token expires after 24 hours. Using an expired pagination token will return an <i>HTTP 400 InvalidToken</i> error.</p>"""
    max_results: NotRequired["capo_evs.types.max_results.MaxResults"]
    """<p>The maximum number of results to return. If you specify <code>MaxResults</code> in the request, the response includes information up to the limit specified.</p>"""
    state: NotRequired["capo_evs.types.environment_state_list.EnvironmentStateList"]
    """<p>The state of an environment. Used to filter response results to return only environments with the specified <code>environmentState</code>.</p>"""

max_results instance-attribute 

max_results: NotRequired[MaxResults]

The maximum number of results to return. If you specify MaxResults in the request, the response includes information up to the limit specified.

next_token instance-attribute 

next_token: NotRequired[PaginationToken]

A unique pagination token for each page. If nextToken is returned, there are more results available. Make the call again using the returned token with all other arguments unchanged to retrieve the next page. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

state instance-attribute 

state: NotRequired[EnvironmentStateList]

The state of an environment. Used to filter response results to return only environments with the specified environmentState.