Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . apprunner ]

list-vpc-ingress-connections

Description

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

See also: AWS API Documentation

Synopsis

  list-vpc-ingress-connections
[--filter <value>]
[--max-results <value>]
[--next-token <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--filter (structure)

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.

Shorthand Syntax:

ServiceArn=string,VpcEndpointId=string

JSON Syntax:

{
  "ServiceArn": "string",
  "VpcEndpointId": "string"
}

--max-results (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.

--next-token (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.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

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.

(structure)

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.