DeleteConnectionCommand

Suggest an Edit

Delete an App Runner connection. You must first ensure that there are no running App Runner services that use this connection. If there are any, the DeleteConnection action fails.

Example Syntax

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

import { AppRunnerClient, DeleteConnectionCommand } from "@aws-sdk/client-apprunner"; // ES Modules import
// const { AppRunnerClient, DeleteConnectionCommand } = require("@aws-sdk/client-apprunner"); // CommonJS import
const client = new AppRunnerClient(config);
const input = { // DeleteConnectionRequest
  ConnectionArn: "STRING_VALUE", // required
};
const command = new DeleteConnectionCommand(input);
const response = await client.send(command);
// { // DeleteConnectionResponse
//   Connection: { // Connection
//     ConnectionName: "STRING_VALUE",
//     ConnectionArn: "STRING_VALUE",
//     ProviderType: "GITHUB" || "BITBUCKET",
//     Status: "PENDING_HANDSHAKE" || "AVAILABLE" || "ERROR" || "DELETED",
//     CreatedAt: new Date("TIMESTAMP"),
//   },
// };

DeleteConnectionCommand Input

See DeleteConnectionCommandInput for more details

Parameter
Type
Description
ConnectionArn
Required
string | undefined

The Amazon Resource Name (ARN) of the App Runner connection that you want to delete.

DeleteConnectionCommand Output

See DeleteConnectionCommandOutput for details

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

A description of the App Runner connection that this request just deleted.

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.