AppRunner / Client / describe_vpc_connector

describe_vpc_connector#

AppRunner.Client.describe_vpc_connector(**kwargs)#

Return a description of an App Runner VPC connector resource.

See also: AWS API Documentation

Request Syntax

response = client.describe_vpc_connector(
    VpcConnectorArn='string'
)
Parameters:

VpcConnectorArn (string) –

[REQUIRED]

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.

Return type:

dict

Returns:

Response Syntax

{
    'VpcConnector': {
        'VpcConnectorName': 'string',
        'VpcConnectorArn': 'string',
        'VpcConnectorRevision': 123,
        'Subnets': [
            'string',
        ],
        'SecurityGroups': [
            'string',
        ],
        'Status': 'ACTIVE'|'INACTIVE',
        'CreatedAt': datetime(2015, 1, 1),
        'DeletedAt': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) –

    • VpcConnector (dict) –

      A description of the App Runner VPC connector that you specified in this request.

      • VpcConnectorName (string) –

        The customer-provided VPC connector name.

      • VpcConnectorArn (string) –

        The Amazon Resource Name (ARN) of this VPC connector.

      • VpcConnectorRevision (integer) –

        The revision of this VPC connector. It’s unique among all the active connectors ( "Status": "ACTIVE") that share the same Name.

        Note

        At this time, App Runner supports only one revision per name.

      • Subnets (list) –

        A list of IDs of subnets that App Runner uses for your service. All IDs are of subnets of a single Amazon VPC.

        • (string) –

      • SecurityGroups (list) –

        A list of IDs of security groups that App Runner uses for access to Amazon Web Services resources under the specified subnets. If not specified, App Runner uses the default security group of the Amazon VPC. The default security group allows all outbound traffic.

        • (string) –

      • Status (string) –

        The current state of the VPC connector. If the status of a connector revision is INACTIVE, it was deleted and can’t be used. Inactive connector revisions are permanently removed some time after they are deleted.

      • CreatedAt (datetime) –

        The time when the VPC connector was created. It’s in Unix time stamp format.

      • DeletedAt (datetime) –

        The time when the VPC connector was deleted. It’s in Unix time stamp format.

Exceptions

  • AppRunner.Client.exceptions.InvalidRequestException

  • AppRunner.Client.exceptions.InternalServiceErrorException

  • AppRunner.Client.exceptions.ResourceNotFoundException