Class GetRouteResponsesCommandProtected

Gets the RouteResponses for a Route.

Example

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

import { ApiGatewayV2Client, GetRouteResponsesCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import
// const { ApiGatewayV2Client, GetRouteResponsesCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import
const client = new ApiGatewayV2Client(config);
const input = { // GetRouteResponsesRequest
  ApiId: "STRING_VALUE", // required
  MaxResults: "STRING_VALUE",
  NextToken: "STRING_VALUE",
  RouteId: "STRING_VALUE", // required
};
const command = new GetRouteResponsesCommand(input);
const response = await client.send(command);
// { // GetRouteResponsesResponse
//   Items: [ // __listOfRouteResponse
//     { // RouteResponse
//       ModelSelectionExpression: "STRING_VALUE",
//       ResponseModels: { // RouteModels
//         "<keys>": "STRING_VALUE",
//       },
//       ResponseParameters: { // RouteParameters
//         "<keys>": { // ParameterConstraints
//           Required: true || false,
//         },
//       },
//       RouteResponseId: "STRING_VALUE",
//       RouteResponseKey: "STRING_VALUE", // required
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

Param

GetRouteResponsesCommandInput

Returns

GetRouteResponsesCommandOutput

See

• GetRouteResponsesCommandInput for command's input shape.
• GetRouteResponsesCommandOutput for command's response shape.
• config for ApiGatewayV2Client's config shape.

Throws

BadRequestException (client fault)

The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

Throws

NotFoundException (client fault)

The resource specified in the request was not found. See the message field for more information.

Throws

TooManyRequestsException (client fault)

A limit has been exceeded. See the accompanying error message for details.

Throws

ApiGatewayV2ServiceException

Base exception class for all service exceptions from ApiGatewayV2 service.