Skip to content

ListBridgesRequest

Source code in docs_src/capo_mediaconnect/types/list_bridges_request.py 
11
12
13
14
15
16
17
class ListBridgesRequest(TypedDict, closed=True):
    filter_arn: NotRequired["str"]
    """<p> Filter the list results to display only the bridges associated with the selected ARN.</p>"""
    max_results: NotRequired["capo_mediaconnect.types.max_results.MaxResults"]
    """<p> The maximum number of results to return per API request. </p> <p>For example, you submit a <code>ListBridges</code> request with <code>MaxResults</code> set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a <code>NextToken</code> value that you can use to fetch the next batch of results.) </p> <p>The service might return fewer results than the <code>MaxResults</code> value. If <code>MaxResults</code> is not included in the request, the service defaults to pagination with a maximum of 10 results per page.</p>"""
    next_token: NotRequired["str"]
    """<p> The token that identifies the batch of results that you want to see. </p> <p>For example, you submit a <code>ListBridges</code> request with <code>MaxResults</code> set at 5. The service returns the first batch of results (up to 5) and a <code>NextToken</code> value. To see the next batch of results, you can submit the <code>ListBridges</code> request a second time and specify the <code>NextToken</code> value.</p>"""

filter_arn instance-attribute 

filter_arn: NotRequired[str]

Filter the list results to display only the bridges associated with the selected ARN.

max_results instance-attribute 

max_results: NotRequired[MaxResults]

The maximum number of results to return per API request.

For example, you submit a ListBridges request with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.)

The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 10 results per page.

next_token instance-attribute 

next_token: NotRequired[str]

The token that identifies the batch of results that you want to see.

For example, you submit a ListBridges request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListBridges request a second time and specify the NextToken value.