Skip to content

ListEndpointsRequest

Source code in docs_src/capo_eventbridge/types/list_endpoints_request.py 
14
15
16
17
18
19
20
21
22
class ListEndpointsRequest(TypedDict, closed=True):
    name_prefix: NotRequired["capo_eventbridge.types.endpoint_name.EndpointName"]
    """<p>A value that will return a subset of the endpoints associated with this account. For example, <code>"NamePrefix": "ABC"</code> will return all endpoints with "ABC" in the name.</p>"""
    home_region: NotRequired["capo_eventbridge.types.home_region.HomeRegion"]
    """<p>The primary Region of the endpoints associated with this account. For example <code>"HomeRegion": "us-east-1"</code>.</p>"""
    next_token: NotRequired["capo_eventbridge.types.next_token.NextToken"]
    """<p>The token returned by a previous call, which you can use to retrieve the next set of results.</p> <p>The value of <code>nextToken</code> is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.</p> <p> Using an expired pagination token results in an <code>HTTP 400 InvalidToken</code> error.</p>"""
    max_results: NotRequired["capo_eventbridge.types.limit_max100.LimitMax100"]
    """<p>The maximum number of results returned by the call.</p>"""

home_region instance-attribute 

home_region: NotRequired[HomeRegion]

The primary Region of the endpoints associated with this account. For example "HomeRegion": "us-east-1".

max_results instance-attribute 

max_results: NotRequired[LimitMax100]

The maximum number of results returned by the call.

name_prefix instance-attribute 

name_prefix: NotRequired[EndpointName]

A value that will return a subset of the endpoints associated with this account. For example, "NamePrefix": "ABC" will return all endpoints with "ABC" in the name.

next_token instance-attribute 

next_token: NotRequired[NextToken]

The token returned by a previous call, which you can use to retrieve the next set of results.

The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.

Using an expired pagination token results in an HTTP 400 InvalidToken error.