GetDeploymentConfigCommand

Suggest an Edit

Gets information about a deployment configuration.

Example Syntax

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

import { CodeDeployClient, GetDeploymentConfigCommand } from "@aws-sdk/client-codedeploy"; // ES Modules import
// const { CodeDeployClient, GetDeploymentConfigCommand } = require("@aws-sdk/client-codedeploy"); // CommonJS import
const client = new CodeDeployClient(config);
const input = { // GetDeploymentConfigInput
  deploymentConfigName: "STRING_VALUE", // required
};
const command = new GetDeploymentConfigCommand(input);
const response = await client.send(command);
// { // GetDeploymentConfigOutput
//   deploymentConfigInfo: { // DeploymentConfigInfo
//     deploymentConfigId: "STRING_VALUE",
//     deploymentConfigName: "STRING_VALUE",
//     minimumHealthyHosts: { // MinimumHealthyHosts
//       type: "HOST_COUNT" || "FLEET_PERCENT",
//       value: Number("int"),
//     },
//     createTime: new Date("TIMESTAMP"),
//     computePlatform: "Server" || "Lambda" || "ECS",
//     trafficRoutingConfig: { // TrafficRoutingConfig
//       type: "TimeBasedCanary" || "TimeBasedLinear" || "AllAtOnce",
//       timeBasedCanary: { // TimeBasedCanary
//         canaryPercentage: Number("int"),
//         canaryInterval: Number("int"),
//       },
//       timeBasedLinear: { // TimeBasedLinear
//         linearPercentage: Number("int"),
//         linearInterval: Number("int"),
//       },
//     },
//     zonalConfig: { // ZonalConfig
//       firstZoneMonitorDurationInSeconds: Number("long"),
//       monitorDurationInSeconds: Number("long"),
//       minimumHealthyHostsPerZone: { // MinimumHealthyHostsPerZone
//         type: "HOST_COUNT" || "FLEET_PERCENT",
//         value: Number("int"),
//       },
//     },
//   },
// };

GetDeploymentConfigCommand Input

See GetDeploymentConfigCommandInput for more details

Parameter
Type
Description
deploymentConfigName
Required
string | undefined

The name of a deployment configuration associated with the user or Amazon Web Services account.

GetDeploymentConfigCommand Output

See GetDeploymentConfigCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
deploymentConfigInfo
DeploymentConfigInfo | undefined

Information about the deployment configuration.

Throws

Name
Fault
Details
DeploymentConfigDoesNotExistException
client

The deployment configuration does not exist with the user or Amazon Web Services account.

DeploymentConfigNameRequiredException
client

The deployment configuration name was not specified.

InvalidComputePlatformException
client

The computePlatform is invalid. The computePlatform should be Lambda, Server, or ECS.

InvalidDeploymentConfigNameException
client

The deployment configuration name was specified in an invalid format.

CodeDeployServiceException
Base exception class for all service exceptions from CodeDeploy service.