DescribeEndpointGroupCommand

Suggest an Edit

Describe an endpoint group.

Example Syntax

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

import { GlobalAcceleratorClient, DescribeEndpointGroupCommand } from "@aws-sdk/client-global-accelerator"; // ES Modules import
// const { GlobalAcceleratorClient, DescribeEndpointGroupCommand } = require("@aws-sdk/client-global-accelerator"); // CommonJS import
const client = new GlobalAcceleratorClient(config);
const input = { // DescribeEndpointGroupRequest
  EndpointGroupArn: "STRING_VALUE", // required
};
const command = new DescribeEndpointGroupCommand(input);
const response = await client.send(command);
// { // DescribeEndpointGroupResponse
//   EndpointGroup: { // EndpointGroup
//     EndpointGroupArn: "STRING_VALUE",
//     EndpointGroupRegion: "STRING_VALUE",
//     EndpointDescriptions: [ // EndpointDescriptions
//       { // EndpointDescription
//         EndpointId: "STRING_VALUE",
//         Weight: Number("int"),
//         HealthState: "INITIAL" || "HEALTHY" || "UNHEALTHY",
//         HealthReason: "STRING_VALUE",
//         ClientIPPreservationEnabled: true || false,
//       },
//     ],
//     TrafficDialPercentage: Number("float"),
//     HealthCheckPort: Number("int"),
//     HealthCheckProtocol: "TCP" || "HTTP" || "HTTPS",
//     HealthCheckPath: "STRING_VALUE",
//     HealthCheckIntervalSeconds: Number("int"),
//     ThresholdCount: Number("int"),
//     PortOverrides: [ // PortOverrides
//       { // PortOverride
//         ListenerPort: Number("int"),
//         EndpointPort: Number("int"),
//       },
//     ],
//   },
// };

DescribeEndpointGroupCommand Input

See DescribeEndpointGroupCommandInput for more details

Parameter
Type
Description
EndpointGroupArn
Required
string | undefined

The Amazon Resource Name (ARN) of the endpoint group to describe.

DescribeEndpointGroupCommand Output

See DescribeEndpointGroupCommandOutput for details

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

The description of an endpoint group.

Throws

Name
Fault
Details
EndpointGroupNotFoundException
client

The endpoint group that you specified doesn't exist.

InternalServiceErrorException
server

There was an internal error for Global Accelerator.

InvalidArgumentException
client

An argument that you specified is invalid.

GlobalAcceleratorServiceException
Base exception class for all service exceptions from GlobalAccelerator service.