AWS CLI Command Reference

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 . quicksight ]

list-vpc-connections

Description

Lists all of the VPC connections in the current set Amazon Web Services Region of an Amazon Web Services account.

See also: AWS API Documentation

Synopsis

  list-vpc-connections
--aws-account-id <value>
[--next-token <value>]
[--max-results <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

--aws-account-id (string)

The Amazon Web Services account ID of the account that contains the VPC connections that you want to list.

--next-token (string)

The token for the next set of results, or null if there are no more results.

--max-results (integer)

The maximum number of results to be returned per request.

--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. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--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

VPCConnectionSummaries -> (list)

A VPCConnectionSummaries object that returns a summary of VPC connection objects.

(structure)

The summary metadata that describes a VPC connection.

VPCConnectionId -> (string)

The ID of the VPC connection that you're creating. This ID is a unique identifier for each Amazon Web Services Region in an Amazon Web Services account.

Arn -> (string)

The Amazon Resource Name (ARN) of the VPC connection.

Name -> (string)

The display name for the VPC connection.

VPCId -> (string)

The Amazon EC2 VPC ID associated with the VPC connection.

SecurityGroupIds -> (list)

The Amazon EC2 security group IDs associated with the VPC connection.

(string)

DnsResolvers -> (list)

A list of IP addresses of DNS resolver endpoints for the VPC connection.

(string)

Status -> (string)

The status of the VPC connection.

AvailabilityStatus -> (string)

The availability status of the VPC connection.

NetworkInterfaces -> (list)

A list of network interfaces.

(structure)

The structure that contains information about a network interface.

SubnetId -> (string)

The subnet ID associated with the network interface.

AvailabilityZone -> (string)

The availability zone that the network interface resides in.

ErrorMessage -> (string)

An error message.

Status -> (string)

The status of the network interface.

NetworkInterfaceId -> (string)

The network interface ID.

RoleArn -> (string)

The ARN of the IAM role associated with the VPC connection.

CreatedTime -> (timestamp)

The time that the VPC connection was created.

LastUpdatedTime -> (timestamp)

The time that the VPC connection was last updated.

NextToken -> (string)

The token for the next set of results, or null if there are no more results.

RequestId -> (string)

The Amazon Web Services request ID for this operation.

Status -> (integer)

The HTTP status of the request.