ListConnectionsCommand

Suggest an Edit

Returns a list of App Runner connections that are associated with your Amazon Web Services account.

Example Syntax

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

import { AppRunnerClient, ListConnectionsCommand } from "@aws-sdk/client-apprunner"; // ES Modules import
// const { AppRunnerClient, ListConnectionsCommand } = require("@aws-sdk/client-apprunner"); // CommonJS import
const client = new AppRunnerClient(config);
const input = { // ListConnectionsRequest
  ConnectionName: "STRING_VALUE",
  MaxResults: Number("int"),
  NextToken: "STRING_VALUE",
};
const command = new ListConnectionsCommand(input);
const response = await client.send(command);
// { // ListConnectionsResponse
//   ConnectionSummaryList: [ // ConnectionSummaryList // required
//     { // ConnectionSummary
//       ConnectionName: "STRING_VALUE",
//       ConnectionArn: "STRING_VALUE",
//       ProviderType: "GITHUB" || "BITBUCKET",
//       Status: "PENDING_HANDSHAKE" || "AVAILABLE" || "ERROR" || "DELETED",
//       CreatedAt: new Date("TIMESTAMP"),
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

ListConnectionsCommand Input

See ListConnectionsCommandInput for more details

Parameter
Type
Description
ConnectionName
string | undefined

If specified, only this connection is returned. If not specified, the result isn't filtered by name.

MaxResults
number | undefined

The maximum number of results to include in each response (result page). Used for a paginated request.

If you don't specify MaxResults, the request retrieves all available results in a single response.

NextToken
string | undefined

A token from a previous result page. Used for a paginated request. The request retrieves the next result page. All other parameter values must be identical to the ones specified in the initial request.

If you don't specify NextToken, the request retrieves the first result page.

ListConnectionsCommand Output

See ListConnectionsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
ConnectionSummaryList
Required
ConnectionSummary[] | undefined

A list of summary information records for connections. In a paginated request, the request returns up to MaxResults records for each call.

NextToken
string | undefined

The token that you can pass in a subsequent request to get the next result page. Returned in a paginated 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.

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