Skip to content

list_connection_groups

Operation

list_connection_groups

list_connection_groups(request: ListConnectionGroupsInput | ListConnectionGroupsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListConnectionGroupsInputDict]) -> ListConnectionGroupsOutput

Lists the connection groups in your Amazon Web Services account.

Parameters:

Name Type Description Default
request ListConnectionGroupsInput | ListConnectionGroupsInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[ListConnectionGroupsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListConnectionGroupsOutput

An instance of ListConnectionGroupsOutput.

list_connection_groups async

list_connection_groups(request: ListConnectionGroupsInput | ListConnectionGroupsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListConnectionGroupsInputDict]) -> ListConnectionGroupsOutput

Lists the connection groups in your Amazon Web Services account.

Parameters:

Name Type Description Default
request ListConnectionGroupsInput | ListConnectionGroupsInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[ListConnectionGroupsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListConnectionGroupsOutput

An instance of ListConnectionGroupsOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

ListConnectionGroupsInputDict

Bases: TypedDict

Dictionary form of ListConnectionGroupsInput.

Attributes

association_filter instance-attribute

Filter by associated Anycast IP list ID.

marker instance-attribute
marker: str | None

The marker for the next set of connection groups to retrieve.

max_items instance-attribute
max_items: int | None

The maximum number of connection groups to return.

ListConnectionGroupsInput dataclass

Bases: _SerdeShape

Dataclass for ListConnectionGroupsInput structure.

Attributes

association_filter class-attribute instance-attribute
association_filter: ConnectionGroupAssociationFilter | None = ...

Filter by associated Anycast IP list ID.

marker class-attribute instance-attribute
marker: str | None = ...

The marker for the next set of connection groups to retrieve.

max_items class-attribute instance-attribute
max_items: int | None = ...

The maximum number of connection groups to return.

Output

ListConnectionGroupsOutput dataclass

Bases: _SerdeShape

Dataclass for ListConnectionGroupsOutput structure.

Attributes

connection_groups class-attribute instance-attribute
connection_groups: list[ConnectionGroupSummary] | None = ...

The list of connection groups that you retrieved.

next_marker class-attribute instance-attribute
next_marker: str | None = ...

A token used for pagination of results returned in the response. You can use the token from the previous request to define where the current request should begin.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.