StartDeploymentCommand

Suggest an Edit

Initiate a manual deployment of the latest commit in a source code repository or the latest image in a source image repository to an App Runner service.

For a source code repository, App Runner retrieves the commit and builds a Docker image. For a source image repository, App Runner retrieves the latest Docker image. In both cases, App Runner then deploys the new image to your service and starts a new container instance.

This is an asynchronous operation. On a successful call, you can use the returned OperationId and the ListOperations call to track the operation's progress.

Example Syntax

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

import { AppRunnerClient, StartDeploymentCommand } from "@aws-sdk/client-apprunner"; // ES Modules import
// const { AppRunnerClient, StartDeploymentCommand } = require("@aws-sdk/client-apprunner"); // CommonJS import
const client = new AppRunnerClient(config);
const input = { // StartDeploymentRequest
  ServiceArn: "STRING_VALUE", // required
};
const command = new StartDeploymentCommand(input);
const response = await client.send(command);
// { // StartDeploymentResponse
//   OperationId: "STRING_VALUE", // required
// };

StartDeploymentCommand Input

See StartDeploymentCommandInput for more details

Parameter
Type
Description
ServiceArn
Required
string | undefined

The Amazon Resource Name (ARN) of the App Runner service that you want to manually deploy to.

StartDeploymentCommand Output

See StartDeploymentCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
OperationId
Required
string | undefined

The unique ID of the asynchronous operation that this request started. You can use it combined with the ListOperations call to track the operation's progress.

Throws

Name
Fault
Details
InternalServiceErrorException
server

An unexpected service exception occurred.

InvalidRequestException
client

One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.

ResourceNotFoundException
client

A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services account.

AppRunnerServiceException
Base exception class for all service exceptions from AppRunner service.