openapi: 3.2.0
info:
version: '2020-05-15'
x-release: v4
title: 'AWS App Runner #X Amz Target=AppRunner.DescribeVpcIngressCon…'
description: 'App Runner
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.'
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: 'AWS App Runner #X Amz Target=AppRunner.DescribeVpcIngressCon…'
paths:
/#X-Amz-Target=AppRunner.DescribeVpcIngressConnection:
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: DescribeVpcIngressConnection
description: Return a full description of an App Runner VPC Ingress Connection resource.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeVpcIngressConnectionResponse'
'480':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'481':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
'482':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeVpcIngressConnectionRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AppRunner.DescribeVpcIngressConnection
tags:
- 'AWS App Runner #X Amz Target=AppRunner.DescribeVpcIngressCon…'
summary: Describe vpc ingress connection
x-summary-source: derived
components:
schemas:
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
ResourceNotFoundException: {}
VpcIngressConnectionStatus:
type: string
enum:
- AVAILABLE
- PENDING_CREATION
- PENDING_UPDATE
- PENDING_DELETION
- FAILED_CREATION
- FAILED_UPDATE
- FAILED_DELETION
- DELETED
IngressVpcConfiguration:
type: object
properties:
VpcId:
allOf:
- $ref: '#/components/schemas/String'
- description: The ID of the VPC that is used for the VPC endpoint.
VpcEndpointId:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The ID of the VPC endpoint that your App Runner service connects to. '
description: The configuration of your VPC and the associated VPC endpoint. The VPC endpoint is an Amazon Web Services PrivateLink resource that allows access to your App Runner services from within an Amazon VPC.
CustomerAccountId:
type: string
pattern: '[0-9]{12}'
minLength: 12
maxLength: 12
VpcIngressConnection:
type: object
properties:
VpcIngressConnectionArn:
allOf:
- $ref: '#/components/schemas/AppRunnerResourceArn'
- description: 'The Amazon Resource Name (ARN) of the VPC Ingress Connection. '
VpcIngressConnectionName:
allOf:
- $ref: '#/components/schemas/VpcIngressConnectionName'
- description: The customer-provided VPC Ingress Connection name.
ServiceArn:
allOf:
- $ref: '#/components/schemas/AppRunnerResourceArn'
- description: 'The Amazon Resource Name (ARN) of the service associated with the VPC Ingress Connection. '
Status:
allOf:
- $ref: '#/components/schemas/VpcIngressConnectionStatus'
- description: 'The current status of the VPC Ingress Connection. The VPC Ingress Connection displays one of the following statuses: AVAILABLE, PENDING_CREATION, PENDING_UPDATE, PENDING_DELETION,FAILED_CREATION, FAILED_UPDATE, FAILED_DELETION, and DELETED.. '
AccountId:
allOf:
- $ref: '#/components/schemas/CustomerAccountId'
- description: The Account Id you use to create the VPC Ingress Connection resource.
DomainName:
allOf:
- $ref: '#/components/schemas/DomainName'
- description: The domain name associated with the VPC Ingress Connection resource.
IngressVpcConfiguration:
allOf:
- $ref: '#/components/schemas/IngressVpcConfiguration'
- description: Specifications for the customer’s VPC and related PrivateLink VPC endpoint that are used to associate with the VPC Ingress Connection resource.
CreatedAt:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: '
The time when the VPC Ingress Connection was created. It''s in the Unix time stamp format.
Type: Timestamp
Required: Yes
The time when the App Runner service was deleted. It''s in the Unix time stamp format.
Type: Timestamp
Required: No