list_vpc_ingress_connections

AppRunner.Client.list_vpc_ingress_connections(**kwargs)

Return a list of App Runner VPC Ingress Connections in your Amazon Web Services account.

See also: AWS API Documentation

Request Syntax

response = client.list_vpc_ingress_connections(
    Filter={
        'ServiceArn': 'string',
        'VpcEndpointId': 'string'
    },
    MaxResults=123,
    NextToken='string'
)
Parameters
  • Filter (dict) --

    The VPC Ingress Connections to be listed based on either the Service Arn or Vpc Endpoint Id, or both.

    • ServiceArn (string) --

      The Amazon Resource Name (ARN) of a service to filter by.

    • VpcEndpointId (string) --

      The ID of a VPC Endpoint to filter by.

  • MaxResults (integer) --

    The maximum number of results to include in each response (result page). It's used for a paginated request.

    If you don't specify MaxResults , the request retrieves all available results in a single response.

  • NextToken (string) --

    A token from a previous result page. It's used for a paginated request. The request retrieves the next result page. All other parameter values must be identical to the ones that are specified in the initial request.

    If you don't specify NextToken , the request retrieves the first result page.

Return type

dict

Returns

Response Syntax

{
    'VpcIngressConnectionSummaryList': [
        {
            'VpcIngressConnectionArn': 'string',
            'ServiceArn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • VpcIngressConnectionSummaryList (list) --

      A list of summary information records for VPC Ingress Connections. In a paginated request, the request returns up to MaxResults records for each call.

      • (dict) --

        Provides summary information about an VPC Ingress Connection, which includes its VPC Ingress Connection ARN and its associated Service ARN.

        • VpcIngressConnectionArn (string) --

          The Amazon Resource Name (ARN) of the VPC Ingress Connection.

        • ServiceArn (string) --

          The Amazon Resource Name (ARN) of the service associated with the VPC Ingress Connection.

    • NextToken (string) --

      The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated request.

Exceptions

  • AppRunner.Client.exceptions.InvalidRequestException
  • AppRunner.Client.exceptions.InternalServiceErrorException