DescribeVpcIngressConnection
Note
AWS App Runner is no longer open to new customers. Existing customers can continue to use the service as normal. This guide applies only to existing customers. If you're not an existing customer, AWS recommends Amazon ECS Express Mode. For more information, see AWS App Runner availability change.
Return a full description of an AWS App Runner VPC Ingress Connection resource.
Request Syntax
{
"VpcIngressConnectionArn": "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.
- VpcIngressConnectionArn
-
The Amazon Resource Name (ARN) of the App Runner VPC Ingress Connection that you want a description for.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Pattern:
arn:aws(-[\w]+)*:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[0-9]{12}:(\w|\/|-){1,1011}Required: Yes
Response Syntax
{
"VpcIngressConnection": {
"AccountId": "string",
"CreatedAt": number,
"DeletedAt": number,
"DomainName": "string",
"IngressVpcConfiguration": {
"VpcEndpointId": "string",
"VpcId": "string"
},
"ServiceArn": "string",
"Status": "string",
"VpcIngressConnectionArn": "string",
"VpcIngressConnectionName": "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.
- VpcIngressConnection
-
A description of the App Runner VPC Ingress Connection that you specified in this request.
Type: VpcIngressConnection object
Errors
For information about the errors that are common to all actions, see Common Error Types.
- 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
- ResourceNotFoundException
-
A resource doesn't exist for the specified Amazon Resource Name (ARN) in your AWS account.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: