Class ListGatewayInstancesCommandProtected

Displays a list of instances associated with the AWS account. This request returns a paginated result. You can use the filterArn property to display only the instances associated with the selected Gateway Amazon Resource Name (ARN).

Example

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

import { MediaConnectClient, ListGatewayInstancesCommand } from "@aws-sdk/client-mediaconnect"; // ES Modules import
// const { MediaConnectClient, ListGatewayInstancesCommand } = require("@aws-sdk/client-mediaconnect"); // CommonJS import
const client = new MediaConnectClient(config);
const input = { // ListGatewayInstancesRequest
  FilterArn: "STRING_VALUE",
  MaxResults: Number("int"),
  NextToken: "STRING_VALUE",
};
const command = new ListGatewayInstancesCommand(input);
const response = await client.send(command);
// { // ListGatewayInstancesResponse
//   Instances: [ // __listOfListedGatewayInstance
//     { // ListedGatewayInstance
//       GatewayArn: "STRING_VALUE", // required
//       GatewayInstanceArn: "STRING_VALUE", // required
//       InstanceId: "STRING_VALUE", // required
//       InstanceState: "REGISTERING" || "ACTIVE" || "DEREGISTERING" || "DEREGISTERED" || "REGISTRATION_ERROR" || "DEREGISTRATION_ERROR",
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

Param

ListGatewayInstancesCommandInput

Returns

ListGatewayInstancesCommandOutput

See

• ListGatewayInstancesCommandInput for command's input shape.
• ListGatewayInstancesCommandOutput 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

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

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.