DescribeVpcConnectorCommand

Return a description of an App Runner VPC connector resource.

Example Syntax

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

import { AppRunnerClient, DescribeVpcConnectorCommand } from "@aws-sdk/client-apprunner"; // ES Modules import
// const { AppRunnerClient, DescribeVpcConnectorCommand } = require("@aws-sdk/client-apprunner"); // CommonJS import
const client = new AppRunnerClient(config);
const input = { // DescribeVpcConnectorRequest
  VpcConnectorArn: "STRING_VALUE", // required
};
const command = new DescribeVpcConnectorCommand(input);
const response = await client.send(command);
// { // DescribeVpcConnectorResponse
//   VpcConnector: { // VpcConnector
//     VpcConnectorName: "STRING_VALUE",
//     VpcConnectorArn: "STRING_VALUE",
//     VpcConnectorRevision: Number("int"),
//     Subnets: [ // StringList
//       "STRING_VALUE",
//     ],
//     SecurityGroups: [
//       "STRING_VALUE",
//     ],
//     Status: "ACTIVE" || "INACTIVE",
//     CreatedAt: new Date("TIMESTAMP"),
//     DeletedAt: new Date("TIMESTAMP"),
//   },
// };

DescribeVpcConnectorCommand Input

Parameter
Type
Description
VpcConnectorArn
Required
string | undefined

The Amazon Resource Name (ARN) of the App Runner VPC connector that you want a description for.

The ARN must be a full VPC connector ARN.

DescribeVpcConnectorCommand Output

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

A description of the App Runner VPC connector that you specified in this request.

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.