- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
GetRouteServerAssociationsCommand
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.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { EC2Client, GetRouteServerAssociationsCommand } from "@aws-sdk/client-ec2"; // ES Modules import
// const { EC2Client, GetRouteServerAssociationsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import
const client = new EC2Client(config);
const input = { // GetRouteServerAssociationsRequest
RouteServerId: "STRING_VALUE", // required
DryRun: true || false,
};
const command = new GetRouteServerAssociationsCommand(input);
const response = await client.send(command);
// { // GetRouteServerAssociationsResult
// RouteServerAssociations: [ // RouteServerAssociationsList
// { // RouteServerAssociation
// RouteServerId: "STRING_VALUE",
// VpcId: "STRING_VALUE",
// State: "associating" || "associated" || "disassociating",
// },
// ],
// };
GetRouteServerAssociationsCommand Input
See GetRouteServerAssociationsCommandInput for more details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
RouteServerIdRequired | string | undefined | The ID of the route server for which to get association information. |
DryRun | boolean | undefined | 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 |
GetRouteServerAssociationsCommand Output
See GetRouteServerAssociationsCommandOutput for details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
RouteServerAssociations | RouteServerAssociation[] | undefined | Information about the associations for the specified route server. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| EC2ServiceException | Base exception class for all service exceptions from EC2 service. |