Skip to content

get_connection_group

Operation

get_connection_group

get_connection_group(request: GetConnectionGroupInput | GetConnectionGroupInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetConnectionGroupInputDict]) -> GetConnectionGroupOutput

Gets information about a connection group.

Parameters:

Name Type Description Default
request GetConnectionGroupInput | GetConnectionGroupInputDict | 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[GetConnectionGroupInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetConnectionGroupOutput

An instance of GetConnectionGroupOutput.

get_connection_group async

get_connection_group(request: GetConnectionGroupInput | GetConnectionGroupInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetConnectionGroupInputDict]) -> GetConnectionGroupOutput

Gets information about a connection group.

Parameters:

Name Type Description Default
request GetConnectionGroupInput | GetConnectionGroupInputDict | 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[GetConnectionGroupInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetConnectionGroupOutput

An instance of GetConnectionGroupOutput.

Input

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

GetConnectionGroupInputDict

Bases: TypedDict

Dictionary form of GetConnectionGroupInput.

Attributes

identifier instance-attribute
identifier: Required[str]

The ID, name, or Amazon Resource Name (ARN) of the connection group.

GetConnectionGroupInput dataclass

Bases: _SerdeShape

Dataclass for GetConnectionGroupInput structure.

Attributes

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

The ID, name, or Amazon Resource Name (ARN) of the connection group.

Output

GetConnectionGroupOutput dataclass

Bases: _SerdeShape

Dataclass for GetConnectionGroupOutput structure.

Attributes

connection_group class-attribute instance-attribute
connection_group: ConnectionGroup | None = ...

The connection group that you retrieved.

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

The current version of the connection group.

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.