Class GetDeploymentCommandProtected

Gets a Deployment.

Example

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

import { ApiGatewayV2Client, GetDeploymentCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import
// const { ApiGatewayV2Client, GetDeploymentCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import
const client = new ApiGatewayV2Client(config);
const input = { // GetDeploymentRequest
  ApiId: "STRING_VALUE", // required
  DeploymentId: "STRING_VALUE", // required
};
const command = new GetDeploymentCommand(input);
const response = await client.send(command);
// { // GetDeploymentResponse
//   AutoDeployed: true || false,
//   CreatedDate: new Date("TIMESTAMP"),
//   DeploymentId: "STRING_VALUE",
//   DeploymentStatus: "PENDING" || "FAILED" || "DEPLOYED",
//   DeploymentStatusMessage: "STRING_VALUE",
//   Description: "STRING_VALUE",
// };

Param

GetDeploymentCommandInput

Returns

GetDeploymentCommandOutput

See

• GetDeploymentCommandInput for command's input shape.
• GetDeploymentCommandOutput for command's response shape.
• config for ApiGatewayV2Client's config shape.

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.