GetStagesCommand

Suggest an Edit

Gets the Stages for an API.

Example Syntax

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

import { ApiGatewayV2Client, GetStagesCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import
// const { ApiGatewayV2Client, GetStagesCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import
const client = new ApiGatewayV2Client(config);
const input = { // GetStagesRequest
  ApiId: "STRING_VALUE", // required
  MaxResults: "STRING_VALUE",
  NextToken: "STRING_VALUE",
};
const command = new GetStagesCommand(input);
const response = await client.send(command);
// { // GetStagesResponse
//   Items: [ // __listOfStage
//     { // Stage
//       AccessLogSettings: { // AccessLogSettings
//         DestinationArn: "STRING_VALUE",
//         Format: "STRING_VALUE",
//       },
//       ApiGatewayManaged: true || false,
//       AutoDeploy: true || false,
//       ClientCertificateId: "STRING_VALUE",
//       CreatedDate: new Date("TIMESTAMP"),
//       DefaultRouteSettings: { // RouteSettings
//         DataTraceEnabled: true || false,
//         DetailedMetricsEnabled: true || false,
//         LoggingLevel: "ERROR" || "INFO" || "OFF",
//         ThrottlingBurstLimit: Number("int"),
//         ThrottlingRateLimit: Number("double"),
//       },
//       DeploymentId: "STRING_VALUE",
//       Description: "STRING_VALUE",
//       LastDeploymentStatusMessage: "STRING_VALUE",
//       LastUpdatedDate: new Date("TIMESTAMP"),
//       RouteSettings: { // RouteSettingsMap
//         "<keys>": {
//           DataTraceEnabled: true || false,
//           DetailedMetricsEnabled: true || false,
//           LoggingLevel: "ERROR" || "INFO" || "OFF",
//           ThrottlingBurstLimit: Number("int"),
//           ThrottlingRateLimit: Number("double"),
//         },
//       },
//       StageName: "STRING_VALUE", // required
//       StageVariables: { // StageVariablesMap
//         "<keys>": "STRING_VALUE",
//       },
//       Tags: { // Tags
//         "<keys>": "STRING_VALUE",
//       },
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

GetStagesCommand Input

See GetStagesCommandInput for more details

Parameter
Type
Description
ApiId
Required
string | undefined

The API identifier.

MaxResults
string | undefined

The maximum number of elements to be returned for this resource.

NextToken
string | undefined

The next page of elements from this collection. Not valid for the last element of the collection.

GetStagesCommand Output

See GetStagesCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Items
Stage[] | undefined

The elements from this collection.

NextToken
string | undefined

The next page of elements from this collection. Not valid for the last element of the collection.

Throws

Name
Fault
Details
BadRequestException
client

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

NotFoundException
client

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

TooManyRequestsException
client

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

ApiGatewayV2ServiceException
Base exception class for all service exceptions from ApiGatewayV2 service.