We are excited to announce the developer preview of our new API documentation for AWS SDK for JavaScript v3. Please follow instructions on the landing page to leave us your feedback.
Protected
Describe an endpoint group for a custom routing accelerator.
Use a bare-bones client and the command you need to make an API call.
import { GlobalAcceleratorClient, DescribeCustomRoutingEndpointGroupCommand } from "@aws-sdk/client-global-accelerator"; // ES Modules import// const { GlobalAcceleratorClient, DescribeCustomRoutingEndpointGroupCommand } = require("@aws-sdk/client-global-accelerator"); // CommonJS importconst client = new GlobalAcceleratorClient(config);const input = { // DescribeCustomRoutingEndpointGroupRequest EndpointGroupArn: "STRING_VALUE", // required};const command = new DescribeCustomRoutingEndpointGroupCommand(input);const response = await client.send(command);// { // DescribeCustomRoutingEndpointGroupResponse// EndpointGroup: { // CustomRoutingEndpointGroup// EndpointGroupArn: "STRING_VALUE",// EndpointGroupRegion: "STRING_VALUE",// DestinationDescriptions: [ // CustomRoutingDestinationDescriptions// { // CustomRoutingDestinationDescription// FromPort: Number("int"),// ToPort: Number("int"),// Protocols: [ // Protocols// "TCP" || "UDP",// ],// },// ],// EndpointDescriptions: [ // CustomRoutingEndpointDescriptions// { // CustomRoutingEndpointDescription// EndpointId: "STRING_VALUE",// },// ],// },// };
DescribeCustomRoutingEndpointGroupCommandInput
DescribeCustomRoutingEndpointGroupCommandOutput
input
response
config
EndpointGroupNotFoundException (client fault)
The endpoint group that you specified doesn't exist.
InternalServiceErrorException (server fault)
There was an internal error for Global Accelerator.
InvalidArgumentException (client fault)
An argument that you specified is invalid.
GlobalAcceleratorServiceException
Base exception class for all service exceptions from GlobalAccelerator service.
Readonly
Static
Describe an endpoint group for a custom routing accelerator.
Example
Use a bare-bones client and the command you need to make an API call.
Param
DescribeCustomRoutingEndpointGroupCommandInput
Returns
DescribeCustomRoutingEndpointGroupCommandOutput
See
input
shape.response
shape.config
shape.Throws
EndpointGroupNotFoundException (client fault)
The endpoint group that you specified doesn't exist.
Throws
InternalServiceErrorException (server fault)
There was an internal error for Global Accelerator.
Throws
InvalidArgumentException (client fault)
An argument that you specified is invalid.
Throws
GlobalAcceleratorServiceException
Base exception class for all service exceptions from GlobalAccelerator service.