ListConnections
Returns a list of AWS App Runner connections that are associated with your AWS account.
Request Syntax
{
"ConnectionName": "string",
"MaxResults": number,
"NextToken": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- ConnectionName
-
If specified, only this connection is returned. If not specified, the result isn't filtered by name.
Type: String
Length Constraints: Minimum length of 4. Maximum length of 32.
Pattern:
[A-Za-z0-9][A-Za-z0-9\-_]{3,31}Required: No
- MaxResults
-
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.Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- NextToken
-
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.Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
.*Required: No
Response Syntax
{
"ConnectionSummaryList": [
{
"ConnectionArn": "string",
"ConnectionName": "string",
"CreatedAt": number,
"ProviderType": "string",
"Status": "string"
}
],
"NextToken": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- ConnectionSummaryList
-
A list of summary information records for connections. In a paginated request, the request returns up to
MaxResultsrecords for each call.Type: Array of ConnectionSummary objects
- NextToken
-
The token that you can pass in a subsequent request to get the next result page. Returned in a paginated request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
.*
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServiceErrorException
-
An unexpected service exception occurred.
HTTP Status Code: 500
- InvalidRequestException
-
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.
HTTP Status Code: 400
Examples
List all connections
This example illustrates how to list all App Runner connections in the AWS account.
Sample Request
$ aws apprunner list-connections --cli-input-json "`cat`"
{
}Sample Response
{
"ConnectionSummaryList": [
{
"ConnectionArn": "arn:aws:apprunner:us-east-1:123456789012:connection/my-github-connection",
"ConnectionName": "my-github-connection",
"Status": "AVAILABLE",
"CreatedAt": "2020-11-03T00:32:51Z",
"ProviderType": "GITHUB"
},
{
"ConnectionArn": "arn:aws:apprunner:us-east-1:123456789012:connection/my-github-org-connection",
"ConnectionName": "my-github-org-connection",
"Status": "AVAILABLE",
"CreatedAt": "2020-11-03T02:54:17Z",
"ProviderType": "GITHUB"
}
]
}List connection by name
This example illustrates how to list a connection by its name.
Sample Request
$ aws apprunner list-connections --cli-input-json "`cat`"
{
"ConnectionName": "my-github-org-connection"
}Sample Response
{
"ConnectionSummaryList": [
{
"ConnectionArn": "arn:aws:apprunner:us-east-1:123456789012:connection/my-github-org-connection",
"ConnectionName": "my-github-org-connection",
"Status": "AVAILABLE",
"CreatedAt": "2020-11-03T02:54:17Z",
"ProviderType": "GITHUB"
}
]
}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
