Skip to content

ListConnectionsRequest

Source code in docs_src/capo_interconnect/types/list_connections_request.py
class ListConnectionsRequest(TypedDict, closed=True):
    max_results: NotRequired["capo_interconnect.types.max_results.MaxResults"]
    """<p>The max number of list results in a single paginated response.</p>"""
    next_token: NotRequired["capo_interconnect.types.next_token.NextToken"]
    """<p>A pagination token from a previous paginated response indicating you wish to get the next page of results.</p>"""
    state: NotRequired["capo_interconnect.types.connection_state.ConnectionState"]
    """<p>Filter the results to only include <a>Connection</a> objects in the given <a>Connection$state</a>.</p>"""
    environment_id: NotRequired["capo_interconnect.types.environment_id.EnvironmentId"]
    """<p>Filter the results to only include <a>Connection</a> objects on the given <a>Environment</a>.</p>"""
    provider: NotRequired["capo_interconnect.types.provider.Provider"]
    """<p>Filter the results to only include <a>Connection</a> objects to the given <a>Provider</a>.</p>"""
    attach_point: NotRequired["capo_interconnect.types.attach_point.AttachPoint"]
    """<p>Filter results to only include <a>Connection</a> objects attached to the given <a>AttachPoint</a>.</p>"""

attach_point instance-attribute

attach_point: NotRequired[AttachPoint]

Filter results to only include Connection objects attached to the given AttachPoint.

environment_id instance-attribute

environment_id: NotRequired[EnvironmentId]

Filter the results to only include Connection objects on the given Environment.

max_results instance-attribute

max_results: NotRequired[MaxResults]

The max number of list results in a single paginated response.

next_token instance-attribute

next_token: NotRequired[NextToken]

A pagination token from a previous paginated response indicating you wish to get the next page of results.

provider instance-attribute

provider: NotRequired[Provider]

Filter the results to only include Connection objects to the given Provider.

state instance-attribute

state: NotRequired[ConnectionState]

Filter the results to only include Connection objects in the given Connection$state.