Skip to content

ListConnectionsRequest

Source code in docs_src/capo_eventbridge/types/list_connections_request.py
class ListConnectionsRequest(TypedDict, closed=True):
    name_prefix: NotRequired["capo_eventbridge.types.connection_name.ConnectionName"]
    """<p>A name prefix to filter results returned. Only connections with a name that starts with the prefix are returned.</p>"""
    connection_state: NotRequired[
        "capo_eventbridge.types.connection_state.ConnectionState"
    ]
    """<p>The state of the connection.</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>"""
    limit: NotRequired["capo_eventbridge.types.limit_max100.LimitMax100"]
    """<p>The maximum number of connections to return.</p>"""

connection_state instance-attribute

connection_state: NotRequired[ConnectionState]

The state of the connection.

limit instance-attribute

limit: NotRequired[LimitMax100]

The maximum number of connections to return.

name_prefix instance-attribute

name_prefix: NotRequired[ConnectionName]

A name prefix to filter results returned. Only connections with a name that starts with the prefix are returned.

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.