- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
GetModelsCommand
Describes existing Models defined for a RestApi resource.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { APIGatewayClient, GetModelsCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
// const { APIGatewayClient, GetModelsCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
const client = new APIGatewayClient(config);
const input = { // GetModelsRequest
restApiId: "STRING_VALUE", // required
position: "STRING_VALUE",
limit: Number("int"),
};
const command = new GetModelsCommand(input);
const response = await client.send(command);
// { // Models
// items: [ // ListOfModel
// { // Model
// id: "STRING_VALUE",
// name: "STRING_VALUE",
// description: "STRING_VALUE",
// schema: "STRING_VALUE",
// contentType: "STRING_VALUE",
// },
// ],
// position: "STRING_VALUE",
// };
GetModelsCommand Input
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
restApiIdRequired | string | undefined | The string identifier of the associated RestApi. |
limit | number | undefined | The maximum number of returned results per page. The default value is 25 and the maximum value is 500. |
position | string | undefined | The current pagination position in the paged result set. |
GetModelsCommand Output
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
items | Model[] | undefined | The current page of elements from this collection. |
position | string | undefined | The current pagination position in the paged result set. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| BadRequestException | client | The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details. |
| NotFoundException | client | The requested resource is not found. Make sure that the request URI is correct. |
| TooManyRequestsException | client | The request has reached its throttling limit. Retry after the specified time period. |
| UnauthorizedException | client | The request is denied because the caller has insufficient permissions. |
| APIGatewayServiceException | Base exception class for all service exceptions from APIGateway service. |