Skip to content

ListLocationsRequest

Source code in docs_src/capo_datasync/types/list_locations_request.py 
13
14
15
16
17
18
19
class ListLocationsRequest(TypedDict, closed=True):
    max_results: NotRequired["capo_datasync.types.max_results.MaxResults"]
    """<p>The maximum number of locations to return.</p>"""
    next_token: NotRequired["capo_datasync.types.next_token.NextToken"]
    """<p>An opaque string that indicates the position at which to begin the next list of locations.</p>"""
    filters: NotRequired["capo_datasync.types.location_filters.LocationFilters"]
    """<p>You can use API filters to narrow down the list of resources returned by <code>ListLocations</code>. For example, to retrieve all tasks on a specific source location, you can use <code>ListLocations</code> with filter name <code>LocationType S3</code> and <code>Operator Equals</code>.</p>"""

filters instance-attribute 

filters: NotRequired[LocationFilters]

You can use API filters to narrow down the list of resources returned by ListLocations. For example, to retrieve all tasks on a specific source location, you can use ListLocations with filter name LocationType S3 and Operator Equals.

max_results instance-attribute 

max_results: NotRequired[MaxResults]

The maximum number of locations to return.

next_token instance-attribute 

next_token: NotRequired[NextToken]

An opaque string that indicates the position at which to begin the next list of locations.