- 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.
GetNetworkTelemetryCommand
Gets the network telemetry of the specified global network.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { NetworkManagerClient, GetNetworkTelemetryCommand } from "@aws-sdk/client-networkmanager"; // ES Modules import
// const { NetworkManagerClient, GetNetworkTelemetryCommand } = require("@aws-sdk/client-networkmanager"); // CommonJS import
const client = new NetworkManagerClient(config);
const input = { // GetNetworkTelemetryRequest
GlobalNetworkId: "STRING_VALUE", // required
CoreNetworkId: "STRING_VALUE",
RegisteredGatewayArn: "STRING_VALUE",
AwsRegion: "STRING_VALUE",
AccountId: "STRING_VALUE",
ResourceType: "STRING_VALUE",
ResourceArn: "STRING_VALUE",
MaxResults: Number("int"),
NextToken: "STRING_VALUE",
};
const command = new GetNetworkTelemetryCommand(input);
const response = await client.send(command);
// { // GetNetworkTelemetryResponse
// NetworkTelemetry: [ // NetworkTelemetryList
// { // NetworkTelemetry
// RegisteredGatewayArn: "STRING_VALUE",
// CoreNetworkId: "STRING_VALUE",
// AwsRegion: "STRING_VALUE",
// AccountId: "STRING_VALUE",
// ResourceType: "STRING_VALUE",
// ResourceId: "STRING_VALUE",
// ResourceArn: "STRING_VALUE",
// Address: "STRING_VALUE",
// Health: { // ConnectionHealth
// Type: "BGP" || "IPSEC",
// Status: "UP" || "DOWN",
// Timestamp: new Date("TIMESTAMP"),
// },
// },
// ],
// NextToken: "STRING_VALUE",
// };
GetNetworkTelemetryCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
GlobalNetworkId Required | string | undefined | The ID of the global network. |
AccountId | string | undefined | The Amazon Web Services account ID. |
AwsRegion | string | undefined | The Amazon Web Services Region. |
CoreNetworkId | string | undefined | The ID of a core network. |
MaxResults | number | undefined | The maximum number of results to return. |
NextToken | string | undefined | The token for the next page of results. |
RegisteredGatewayArn | string | undefined | The ARN of the gateway. |
ResourceArn | string | undefined | The ARN of the resource. |
ResourceType | string | undefined | The resource type. The following are the supported resource types:
|
GetNetworkTelemetryCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
NetworkTelemetry | NetworkTelemetry[] | undefined | The network telemetry. |
NextToken | string | undefined | The token for the next page of results. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
AccessDeniedException | client | You do not have sufficient access to perform this action. |
InternalServerException | server | The request has failed due to an internal error. |
ResourceNotFoundException | client | The specified resource could not be found. |
ThrottlingException | client | The request was denied due to request throttling. |
ValidationException | client | The input fails to satisfy the constraints. |
NetworkManagerServiceException | Base exception class for all service exceptions from NetworkManager service. |