Class DescribeGatewayInstanceCommandProtected

Displays the details of an instance.

Example

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

import { MediaConnectClient, DescribeGatewayInstanceCommand } from "@aws-sdk/client-mediaconnect"; // ES Modules import
// const { MediaConnectClient, DescribeGatewayInstanceCommand } = require("@aws-sdk/client-mediaconnect"); // CommonJS import
const client = new MediaConnectClient(config);
const input = { // DescribeGatewayInstanceRequest
  GatewayInstanceArn: "STRING_VALUE", // required
};
const command = new DescribeGatewayInstanceCommand(input);
const response = await client.send(command);
// { // DescribeGatewayInstanceResponse
//   GatewayInstance: { // GatewayInstance
//     BridgePlacement: "AVAILABLE" || "LOCKED", // required
//     ConnectionStatus: "CONNECTED" || "DISCONNECTED", // required
//     GatewayArn: "STRING_VALUE", // required
//     GatewayInstanceArn: "STRING_VALUE", // required
//     InstanceId: "STRING_VALUE", // required
//     InstanceMessages: [ // __listOfMessageDetail
//       { // MessageDetail
//         Code: "STRING_VALUE", // required
//         Message: "STRING_VALUE", // required
//         ResourceName: "STRING_VALUE",
//       },
//     ],
//     InstanceState: "REGISTERING" || "ACTIVE" || "DEREGISTERING" || "DEREGISTERED" || "REGISTRATION_ERROR" || "DEREGISTRATION_ERROR", // required
//     RunningBridgeCount: Number("int"), // required
//   },
// };

Param

DescribeGatewayInstanceCommandInput

Returns

DescribeGatewayInstanceCommandOutput

See

• DescribeGatewayInstanceCommandInput for command's input shape.
• DescribeGatewayInstanceCommandOutput for command's response shape.
• config for MediaConnectClient's config shape.

Throws

BadRequestException (client fault) Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.

Throws

ConflictException (client fault) Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.

Throws

ForbiddenException (client fault) Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.

Throws

InternalServerErrorException (server fault) Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.

Throws

NotFoundException (client fault) Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.

Throws

ServiceUnavailableException (server fault) Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.

Throws

TooManyRequestsException (client fault) Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.

Throws

MediaConnectServiceException

Base exception class for all service exceptions from MediaConnect service.