AppRunner / Client / describe_vpc_ingress_connection
describe_vpc_ingress_connection#
- AppRunner.Client.describe_vpc_ingress_connection(**kwargs)#
Return a full description of an App Runner VPC Ingress Connection resource.
See also: AWS API Documentation
Request Syntax
response = client.describe_vpc_ingress_connection( VpcIngressConnectionArn='string' )
- Parameters:
VpcIngressConnectionArn (string) –
[REQUIRED]
The Amazon Resource Name (ARN) of the App Runner VPC Ingress Connection that you want a description for.
- Return type:
dict
- Returns:
Response Syntax
{ 'VpcIngressConnection': { 'VpcIngressConnectionArn': 'string', 'VpcIngressConnectionName': 'string', 'ServiceArn': 'string', 'Status': 'AVAILABLE'|'PENDING_CREATION'|'PENDING_UPDATE'|'PENDING_DELETION'|'FAILED_CREATION'|'FAILED_UPDATE'|'FAILED_DELETION'|'DELETED', 'AccountId': 'string', 'DomainName': 'string', 'IngressVpcConfiguration': { 'VpcId': 'string', 'VpcEndpointId': 'string' }, 'CreatedAt': datetime(2015, 1, 1), 'DeletedAt': datetime(2015, 1, 1) } }
Response Structure
(dict) –
VpcIngressConnection (dict) –
A description of the App Runner VPC Ingress Connection that you specified in this request.
VpcIngressConnectionArn (string) –
The Amazon Resource Name (ARN) of the VPC Ingress Connection.
VpcIngressConnectionName (string) –
The customer-provided VPC Ingress Connection name.
ServiceArn (string) –
The Amazon Resource Name (ARN) of the service associated with the VPC Ingress Connection.
Status (string) –
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
, andDELETED
..AccountId (string) –
The Account Id you use to create the VPC Ingress Connection resource.
DomainName (string) –
The domain name associated with the VPC Ingress Connection resource.
IngressVpcConfiguration (dict) –
Specifications for the customer’s VPC and related PrivateLink VPC endpoint that are used to associate with the VPC Ingress Connection resource.
VpcId (string) –
The ID of the VPC that is used for the VPC endpoint.
VpcEndpointId (string) –
The ID of the VPC endpoint that your App Runner service connects to.
CreatedAt (datetime) –
The time when the VPC Ingress Connection was created. It’s in the Unix time stamp format.
Type: Timestamp
Required: Yes
DeletedAt (datetime) –
The time when the App Runner service was deleted. It’s in the Unix time stamp format.
Type: Timestamp
Required: No
Exceptions
AppRunner.Client.exceptions.InvalidRequestException
AppRunner.Client.exceptions.InternalServiceErrorException
AppRunner.Client.exceptions.ResourceNotFoundException