openapi: 3.0.0
info:
version: '2020-05-15'
x-release: v4
title: 'AWS App Runner Amazon App Runner AWS App Runner API #X Amz Target=AppRunner.ListConnections API'
description:
App Runner is an application service that provides a fast, simple, and cost-effective way to go directly from an existing container image or source code to a running service in the Amazon Web Services Cloud in seconds. You don't need to learn new technologies, decide which compute service to use, or understand how to provision and configure Amazon Web Services resources.
App Runner connects directly to your container registry or source code repository. It provides an automatic delivery pipeline with fully managed operations, high performance, scalability, and security.
For more information about App Runner, see the App Runner Developer Guide. For release information, see the App Runner Release Notes.
To install the Software Development Kits (SDKs), Integrated Development Environment (IDE) Toolkits, and command line tools that you can use to access the API, see Tools for Amazon Web Services.
Endpoints
For a list of Region-specific endpoints that App Runner supports, see App Runner endpoints and quotas in the Amazon Web Services General Reference.
x-logo: url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png backgroundColor: '#FFFFFF' termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: apprunner x-aws-signingName: apprunner x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/apprunner-2020-05-15.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true servers: - url: http://apprunner.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The AWS App Runner multi-region endpoint - url: https://apprunner.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The AWS App Runner multi-region endpoint - url: http://apprunner.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The AWS App Runner endpoint for China (Beijing) and China (Ningxia) - url: https://apprunner.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The AWS App Runner endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: '#X Amz Target=AppRunner.ListConnections' paths: /#X-Amz-Target=AppRunner.ListConnections: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: ListConnections description: Returns a list of App Runner connections that are associated with your Amazon Web Services account. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListConnectionsResponse' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: InternalServiceErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServiceErrorException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListConnectionsRequest' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - AppRunner.ListConnections tags: - '#X Amz Target=AppRunner.ListConnections' components: schemas: ListConnectionsRequest: type: object title: ListConnectionsRequest properties: ConnectionName: allOf: - $ref: '#/components/schemas/ConnectionName' - description: If specified, only this connection is returned. If not specified, the result isn't filtered by name. MaxResults: allOf: - $ref: '#/components/schemas/MaxResults' - description: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.
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.
MaxResults records for each call.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The token that you can pass in a subsequent request to get the next result page. Returned in a paginated request.
MaxResults:
type: integer
minimum: 1
maximum: 100
ConnectionStatus:
type: string
enum:
- PENDING_HANDSHAKE
- AVAILABLE
- ERROR
- DELETED
ConnectionName:
type: string
pattern: '[A-Za-z0-9][A-Za-z0-9\-_]{3,31}'
minLength: 4
maxLength: 32
ConnectionSummary:
type: object
properties:
ConnectionName:
allOf:
- $ref: '#/components/schemas/ConnectionName'
- description: The customer-provided connection name.
ConnectionArn:
allOf:
- $ref: '#/components/schemas/AppRunnerResourceArn'
- description: The Amazon Resource Name (ARN) of this connection.
ProviderType:
allOf:
- $ref: '#/components/schemas/ProviderType'
- description: The source repository provider.
Status:
allOf:
- $ref: '#/components/schemas/ConnectionStatus'
- description: The current state of the App Runner connection. When the state is AVAILABLE, you can use the connection to create an App Runner service.
CreatedAt:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The App Runner connection creation time, expressed as a Unix time stamp.
description: Provides summary information about an App Runner connection resource.
NextToken:
type: string
pattern: .*
minLength: 1
maxLength: 1024
ConnectionSummaryList:
type: array
items:
$ref: '#/components/schemas/ConnectionSummary'
ProviderType:
type: string
enum:
- GITHUB
AppRunnerResourceArn:
type: string
pattern: arn:aws(-[\w]+)*:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[0-9]{12}:(\w|\/|-){1,1011}
minLength: 1
maxLength: 1011
InternalServiceErrorException: {}
InvalidRequestException: {}
Timestamp:
type: string
format: date-time
parameters:
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
in: header
schema:
type: string
required: false
X-Amz-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
X-Amz-Security-Token:
name: X-Amz-Security-Token
in: header
schema:
type: string
required: false
X-Amz-Content-Sha256:
name: X-Amz-Content-Sha256
in: header
schema:
type: string
required: false
X-Amz-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
X-Amz-Credential:
name: X-Amz-Credential
in: header
schema:
type: string
required: false
X-Amz-Algorithm:
name: X-Amz-Algorithm
in: header
schema:
type: string
required: false
securitySchemes:
hmac:
type: apiKey
name: Authorization
in: header
description: Amazon Signature authorization v4
x-amazon-apigateway-authtype: awsSigv4
externalDocs:
description: Amazon Web Services documentation
url: https://docs.aws.amazon.com/apprunner/
x-hasEquivalentPaths: true