Skip to content

get_route_server_associations

Operation

get_route_server_associations

get_route_server_associations(request: GetRouteServerAssociationsInput | GetRouteServerAssociationsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetRouteServerAssociationsInputDict]) -> GetRouteServerAssociationsOutput

Gets information about the associations for the specified route server.

A route server association is the connection established between a route server and a VPC.

For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.

Parameters:

Name Type Description Default
request GetRouteServerAssociationsInput | GetRouteServerAssociationsInputDict | 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[GetRouteServerAssociationsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetRouteServerAssociationsOutput

An instance of GetRouteServerAssociationsOutput.

get_route_server_associations async

get_route_server_associations(request: GetRouteServerAssociationsInput | GetRouteServerAssociationsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetRouteServerAssociationsInputDict]) -> GetRouteServerAssociationsOutput

Gets information about the associations for the specified route server.

A route server association is the connection established between a route server and a VPC.

For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.

Parameters:

Name Type Description Default
request GetRouteServerAssociationsInput | GetRouteServerAssociationsInputDict | 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[GetRouteServerAssociationsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetRouteServerAssociationsOutput

An instance of GetRouteServerAssociationsOutput.

Input

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

GetRouteServerAssociationsInputDict

Bases: TypedDict

Dictionary form of GetRouteServerAssociationsInput.

Attributes

dry_run instance-attribute
dry_run: bool | None

A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

route_server_id instance-attribute
route_server_id: Required[str]

The ID of the route server for which to get association information.

GetRouteServerAssociationsInput dataclass

Bases: _SerdeShape

Dataclass for GetRouteServerAssociationsInput structure.

Attributes

dry_run class-attribute instance-attribute
dry_run: bool | None = ...

A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

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

The ID of the route server for which to get association information.

Output

GetRouteServerAssociationsOutput dataclass

Bases: _SerdeShape

Dataclass for GetRouteServerAssociationsOutput structure.

Attributes

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.

route_server_associations class-attribute instance-attribute
route_server_associations: list[RouteServerAssociation] | None = ...

Information about the associations for the specified route server.