DescribeVpcConnector
Return a description of an AWS App Runner VPC connector resource.
Request Syntax
{
"VpcConnectorArn": "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.
- VpcConnectorArn
-
The Amazon Resource Name (ARN) of the App Runner VPC connector that you want a description for.
The ARN must be a full VPC connector ARN.
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
{
"VpcConnector": {
"CreatedAt": number,
"DeletedAt": number,
"SecurityGroups": [ "string" ],
"Status": "string",
"Subnets": [ "string" ],
"VpcConnectorArn": "string",
"VpcConnectorName": "string",
"VpcConnectorRevision": number
}
}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.
- VpcConnector
-
A description of the App Runner VPC connector that you specified in this request.
Type: VpcConnector object
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
- ResourceNotFoundException
-
A resource doesn't exist for the specified Amazon Resource Name (ARN) in your AWS account.
HTTP Status Code: 400
Examples
Describe a VPC connector
This example illustrates how to get a description of an App Runner VPC connector.
Sample Request
$ aws apprunner describe-vpc-connector --cli-input-json "`cat`"
{
"VpcConnectorArn": "arn:aws:apprunner:us-east-1:123456789012:vpcconnector/my-vpc-connector/1/3f2eb10e2c494674952026f646844e3d"
}Sample Response
{
"VpcConnector": {
"VpcConnectorArn": "arn:aws:apprunner:us-east-1:123456789012:vpcconnector/my-vpc-connector/1/3f2eb10e2c494674952026f646844e3d",
"VpcConnectorName": "my-vpc-connector",
"VpcConnectorRevision": 1,
"Subnets": ["subnet-123", "subnet-456"],
"SecurityGroups": ["sg-123", "sg-456"],
"Status": "ACTIVE",
"CreatedAt": "2021-08-18T23:36:45.374Z"
}
}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
