DescribeTransitGatewayRouteTableAnnouncementsCommand

Suggest an Edit

Describes one or more transit gateway route table advertisements.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { EC2Client, DescribeTransitGatewayRouteTableAnnouncementsCommand } from "@aws-sdk/client-ec2"; // ES Modules import
// const { EC2Client, DescribeTransitGatewayRouteTableAnnouncementsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import
const client = new EC2Client(config);
const input = { // DescribeTransitGatewayRouteTableAnnouncementsRequest
  TransitGatewayRouteTableAnnouncementIds: [ // TransitGatewayRouteTableAnnouncementIdStringList
    "STRING_VALUE",
  ],
  Filters: [ // FilterList
    { // Filter
      Name: "STRING_VALUE",
      Values: [ // ValueStringList
        "STRING_VALUE",
      ],
    },
  ],
  MaxResults: Number("int"),
  NextToken: "STRING_VALUE",
  DryRun: true || false,
};
const command = new DescribeTransitGatewayRouteTableAnnouncementsCommand(input);
const response = await client.send(command);
// { // DescribeTransitGatewayRouteTableAnnouncementsResult
//   TransitGatewayRouteTableAnnouncements: [ // TransitGatewayRouteTableAnnouncementList
//     { // TransitGatewayRouteTableAnnouncement
//       TransitGatewayRouteTableAnnouncementId: "STRING_VALUE",
//       TransitGatewayId: "STRING_VALUE",
//       CoreNetworkId: "STRING_VALUE",
//       PeerTransitGatewayId: "STRING_VALUE",
//       PeerCoreNetworkId: "STRING_VALUE",
//       PeeringAttachmentId: "STRING_VALUE",
//       AnnouncementDirection: "outgoing" || "incoming",
//       TransitGatewayRouteTableId: "STRING_VALUE",
//       State: "available" || "pending" || "failing" || "failed" || "deleting" || "deleted",
//       CreationTime: new Date("TIMESTAMP"),
//       Tags: [ // TagList
//         { // Tag
//           Key: "STRING_VALUE",
//           Value: "STRING_VALUE",
//         },
//       ],
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

DescribeTransitGatewayRouteTableAnnouncementsCommand Input

See DescribeTransitGatewayRouteTableAnnouncementsCommandInput for more details

Parameter
Type
Description
DryRun
boolean | undefined

Checks 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.

Filters
Filter[] | undefined

The filters associated with the transit gateway policy table.

MaxResults
number | undefined

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

NextToken
string | undefined

The token for the next page of results.

TransitGatewayRouteTableAnnouncementIds
string[] | undefined

The IDs of the transit gateway route tables that are being advertised.

DescribeTransitGatewayRouteTableAnnouncementsCommand Output

See DescribeTransitGatewayRouteTableAnnouncementsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
NextToken
string | undefined

The token for the next page of results.

TransitGatewayRouteTableAnnouncements
TransitGatewayRouteTableAnnouncement[] | undefined

Describes the transit gateway route table announcement.

Throws

Name
Fault
Details
EC2ServiceException
Base exception class for all service exceptions from EC2 service.