NOTE: For Version 3 of the AWS SDK for PHP, please see the V3 User Guide and V3 API Reference.

# Class DirectConnectClient

Client to interact with AWS Direct Connect

  Guzzle\Common\AbstractHasDispatcher implements Guzzle\Common\HasDispatcherInterface
  Guzzle\Http\Client implements Guzzle\Http\ClientInterface
  Guzzle\Service\Client implements Guzzle\Service\ClientInterface
  Aws\Common\Client\AbstractClient implements Aws\Common\Client\AwsClientInterface
  Aws\DirectConnect\DirectConnectClient

Namespace: Aws\DirectConnect
Link: User guide
Link: API docs
Located at Aws/DirectConnect/DirectConnectClient.php

## Methods summary

- `public static` `factory ( array|Collection $config = array() )`

  Factory method to create a new AWS Direct Connect client using an array of configuration options.

- `public` `allocateConnectionOnInterconnect ( array $args = array() )`

  Executes the AllocateConnectionOnInterconnect operation.

- `public` `allocatePrivateVirtualInterface ( array $args = array() )`

  Executes the AllocatePrivateVirtualInterface operation.

- `public` `allocatePublicVirtualInterface ( array $args = array() )`

  Executes the AllocatePublicVirtualInterface operation.

- `public` `confirmConnection ( array $args = array() )`

  Executes the ConfirmConnection operation.

- `public` `confirmPrivateVirtualInterface ( array $args = array() )`

  Executes the ConfirmPrivateVirtualInterface operation.

- `public` `confirmPublicVirtualInterface ( array $args = array() )`

  Executes the ConfirmPublicVirtualInterface operation.

- `public` `createConnection ( array $args = array() )`

  Executes the CreateConnection operation.

- `public` `createInterconnect ( array $args = array() )`

  Executes the CreateInterconnect operation.

- `public` `createPrivateVirtualInterface ( array $args = array() )`

  Executes the CreatePrivateVirtualInterface operation.

- `public` `createPublicVirtualInterface ( array $args = array() )`

  Executes the CreatePublicVirtualInterface operation.

- `public` `deleteConnection ( array $args = array() )`

  Executes the DeleteConnection operation.

- `public` `deleteInterconnect ( array $args = array() )`

  Executes the DeleteInterconnect operation.

- `public` `deleteVirtualInterface ( array $args = array() )`

  Executes the DeleteVirtualInterface operation.

- `public` `describeConnections ( array $args = array() )`

  Executes the DescribeConnections operation.

- `public` `describeConnectionsOnInterconnect ( array $args = array() )`

  Executes the DescribeConnectionsOnInterconnect operation.

- `public` `describeInterconnects ( array $args = array() )`

  Executes the DescribeInterconnects operation.

- `public` `describeLocations ( array $args = array() )`

  Executes the DescribeLocations operation.

- `public` `describeVirtualGateways ( array $args = array() )`

  Executes the DescribeVirtualGateways operation.

- `public` `describeVirtualInterfaces ( array $args = array() )`

  Executes the DescribeVirtualInterfaces operation.

- `public` `getDescribeConnectionsIterator ( array $args = array() )`

  The input array uses the parameters of the DescribeConnections operation

- `public` `getDescribeConnectionsOnInterconnectIterator ( array $args = array() )`

  The input array uses the parameters of the DescribeConnectionsOnInterconnect operation

- `public` `getDescribeInterconnectsIterator ( array $args = array() )`

  The input array uses the parameters of the DescribeInterconnects operation

- `public` `getDescribeLocationsIterator ( array $args = array() )`

  The input array uses the parameters of the DescribeLocations operation

- `public` `getDescribeVirtualGatewaysIterator ( array $args = array() )`

  The input array uses the parameters of the DescribeVirtualGateways operation

- `public` `getDescribeVirtualInterfacesIterator ( array $args = array() )`

  The input array uses the parameters of the DescribeVirtualInterfaces operation

## Methods detail

# `public static `Aws\DirectConnect\DirectConnectClient``
`factory( array|`Guzzle\Common\Collection` $config = array() )`

Factory method to create a new AWS Direct Connect client using an array of configuration options.

#### Parameters

$config
  `array|`Guzzle\Common\Collection``
  $config Client configuration data

#### Returns

``Aws\DirectConnect\DirectConnectClient``

#### Link

http://docs.aws.amazon.com/aws-sdk-php/v2/guide/configuration.html#client-configuration-options

#### Overrides

`Guzzle\Service\Client::factory`
# `public `Guzzle\Service\Resource\Model``
`allocateConnectionOnInterconnect( array $args = array() )`

Executes the AllocateConnectionOnInterconnect operation.

Creates a hosted connection on an interconnect.

Allocates a VLAN number and a specified amount of bandwidth for use by a hosted connection on the given interconnect.

#### Examples

- Basic formatting example

      $result = $client->allocateConnectionOnInterconnect(array(
          // bandwidth is required
          'bandwidth' => 'string',
          // connectionName is required
          'connectionName' => 'string',
          // ownerAccount is required
          'ownerAccount' => 'string',
          // interconnectId is required
          'interconnectId' => 'string',
          // vlan is required
          'vlan' => integer,
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - bandwidth => (string)

    Bandwidth of the connection.

    Example: "500Mbps"

    Default: None

  - connectionName => (string)

    Name of the provisioned connection.

    Example: "500M Connection to AWS"

    Default: None

  - ownerAccount => (string)

    Numeric account Id of the customer for whom the connection will be provisioned.

    Example: 123443215678

    Default: None

  - interconnectId => (string)

    ID of the interconnect on which the connection will be provisioned.

    Example: dxcon-456abc78

    Default: None

  - vlan => (int)

    The dedicated VLAN provisioned to the connection.

    Example: 101

    Default: None

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- ownerAccount => (string)
- connectionId => (string)

  ID of the connection.

  Example: dxcon-fg5678gh

  Default: None

- connectionName => (string)

  The name of the connection.

  Example: "My Connection to AWS"

  Default: None

- connectionState => (string)
  State of the connection.
  - Ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
  - Requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
  - Pending: The connection has been approved, and is being initialized.
  - Available: The network link is up, and the connection is ready for use.
  - Down: The network link is down.
  - Deleted: The connection has been deleted.
  - Rejected: A hosted connection in the 'Ordering' state will enter the 'Rejected' state if it is deleted by the end customer.
- region => (string)

  The AWS region where the connection is located.

  Example: us-east-1

  Default: None

- location => (string)

  Where the connection is located.

  Example: EqSV5

  Default: None

- bandwidth => (string)

  Bandwidth of the connection.

  Example: 1Gbps (for regular connections), or 500Mbps (for hosted connections)

  Default: None

- vlan => (int)

  The VLAN ID.

  Example: 101

- partnerName => (string)

# `public `Guzzle\Service\Resource\Model``
`allocatePrivateVirtualInterface( array $args = array() )`

Executes the AllocatePrivateVirtualInterface operation.

Provisions a private virtual interface to be owned by a different customer.

The owner of a connection calls this function to provision a private virtual interface which will be owned by another AWS customer.

Virtual interfaces created using this function must be confirmed by the virtual interface owner by calling ConfirmPrivateVirtualInterface. Until this step has been completed, the virtual interface will be in 'Confirming' state, and will not be available for handling traffic.

#### Examples

- Basic formatting example

      $result = $client->allocatePrivateVirtualInterface(array(
          // connectionId is required
          'connectionId' => 'string',
          // ownerAccount is required
          'ownerAccount' => 'string',
          // newPrivateVirtualInterfaceAllocation is required
          'newPrivateVirtualInterfaceAllocation' => array(
              // virtualInterfaceName is required
              'virtualInterfaceName' => 'string',
              // vlan is required
              'vlan' => integer,
              // asn is required
              'asn' => integer,
              'authKey' => 'string',
              'amazonAddress' => 'string',
              'customerAddress' => 'string',
          ),
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - connectionId => (string)

    The connection ID on which the private virtual interface is provisioned.

    Default: None

  - ownerAccount => (string)

    The AWS account that will own the new private virtual interface.

    Default: None

  - newPrivateVirtualInterfaceAllocation => (associative-array)

    Detailed information for the private virtual interface to be provisioned.

    Default: None

    - virtualInterfaceName => (string)

      The name of the virtual interface assigned by the customer.

      Example: "My VPC"

    - vlan => (int)

      The VLAN ID.

      Example: 101

    - asn => (int)

      Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

      Example: 65000

    - authKey => (string)

      Authentication key for BGP configuration.

      Example: asdf34example

    - amazonAddress => (string)

      IP address assigned to the Amazon interface.

      Example: 192.168.1.1/30

    - customerAddress => (string)

      IP address assigned to the customer interface.

      Example: 192.168.1.2/30

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- ownerAccount => (string)
- virtualInterfaceId => (string)

  ID of the virtual interface.

  Example: dxvif-123dfg56

  Default: None

- location => (string)

  Where the connection is located.

  Example: EqSV5

  Default: None

- connectionId => (string)

  ID of the connection.

  Example: dxcon-fg5678gh

  Default: None

- virtualInterfaceType => (string)

  The type of virtual interface.

  Example: private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, and so on.)

- virtualInterfaceName => (string)

  The name of the virtual interface assigned by the customer.

  Example: "My VPC"

- vlan => (int)

  The VLAN ID.

  Example: 101

- asn => (int)

  Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

  Example: 65000

- authKey => (string)

  Authentication key for BGP configuration.

  Example: asdf34example

- amazonAddress => (string)

  IP address assigned to the Amazon interface.

  Example: 192.168.1.1/30

- customerAddress => (string)

  IP address assigned to the customer interface.

  Example: 192.168.1.2/30

- virtualInterfaceState => (string)
  State of the virtual interface.
  - Confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.
  - Verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.
  - Pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.
  - Available: A virtual interface that is able to forward traffic.
  - Deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.
  - Deleted: A virtual interface that cannot forward traffic.
  - Rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the 'Confirming' state is deleted by the virtual interface owner, the virtual interface will enter the 'Rejected' state.
- customerRouterConfig => (string)

  Information for generating the customer router configuration.

- virtualGatewayId => (string)

  The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces.

  Example: vgw-123er56

- routeFilterPrefixes => (array<associative-array>)

  A list of routes to be advertised to the AWS network in this region (public virtual interface) or your VPC (private virtual interface).

  - (associative-array)

    A route filter prefix that the customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.

    - cidr => (string)

      CIDR notation for the advertised route. Multiple routes are separated by commas.

      Example: 10.10.10.0/24,10.10.11.0/24

# `public `Guzzle\Service\Resource\Model``
`allocatePublicVirtualInterface( array $args = array() )`

Executes the AllocatePublicVirtualInterface operation.

Provisions a public virtual interface to be owned by a different customer.

The owner of a connection calls this function to provision a public virtual interface which will be owned by another AWS customer.

Virtual interfaces created using this function must be confirmed by the virtual interface owner by calling ConfirmPublicVirtualInterface. Until this step has been completed, the virtual interface will be in 'Confirming' state, and will not be available for handling traffic.

#### Examples

- Basic formatting example

      $result = $client->allocatePublicVirtualInterface(array(
          // connectionId is required
          'connectionId' => 'string',
          // ownerAccount is required
          'ownerAccount' => 'string',
          // newPublicVirtualInterfaceAllocation is required
          'newPublicVirtualInterfaceAllocation' => array(
              // virtualInterfaceName is required
              'virtualInterfaceName' => 'string',
              // vlan is required
              'vlan' => integer,
              // asn is required
              'asn' => integer,
              'authKey' => 'string',
              // amazonAddress is required
              'amazonAddress' => 'string',
              // customerAddress is required
              'customerAddress' => 'string',
              // routeFilterPrefixes is required
              'routeFilterPrefixes' => array(
                  array(
                      'cidr' => 'string',
                  ),
                  // ... repeated
              ),
          ),
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - connectionId => (string)

    The connection ID on which the public virtual interface is provisioned.

    Default: None

  - ownerAccount => (string)

    The AWS account that will own the new public virtual interface.

    Default: None

  - newPublicVirtualInterfaceAllocation => (associative-array)

    Detailed information for the public virtual interface to be provisioned.

    Default: None

    - virtualInterfaceName => (string)

      The name of the virtual interface assigned by the customer.

      Example: "My VPC"

    - vlan => (int)

      The VLAN ID.

      Example: 101

    - asn => (int)

      Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

      Example: 65000

    - authKey => (string)

      Authentication key for BGP configuration.

      Example: asdf34example

    - amazonAddress => (string)

      IP address assigned to the Amazon interface.

      Example: 192.168.1.1/30

    - customerAddress => (string)

      IP address assigned to the customer interface.

      Example: 192.168.1.2/30

    - routeFilterPrefixes => (array<associative-array>)

      A list of routes to be advertised to the AWS network in this region (public virtual interface) or your VPC (private virtual interface).

      - (associative-array)

        A route filter prefix that the customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.

        - cidr => (string)

          CIDR notation for the advertised route. Multiple routes are separated by commas.

          Example: 10.10.10.0/24,10.10.11.0/24

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- ownerAccount => (string)
- virtualInterfaceId => (string)

  ID of the virtual interface.

  Example: dxvif-123dfg56

  Default: None

- location => (string)

  Where the connection is located.

  Example: EqSV5

  Default: None

- connectionId => (string)

  ID of the connection.

  Example: dxcon-fg5678gh

  Default: None

- virtualInterfaceType => (string)

  The type of virtual interface.

  Example: private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, and so on.)

- virtualInterfaceName => (string)

  The name of the virtual interface assigned by the customer.

  Example: "My VPC"

- vlan => (int)

  The VLAN ID.

  Example: 101

- asn => (int)

  Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

  Example: 65000

- authKey => (string)

  Authentication key for BGP configuration.

  Example: asdf34example

- amazonAddress => (string)

  IP address assigned to the Amazon interface.

  Example: 192.168.1.1/30

- customerAddress => (string)

  IP address assigned to the customer interface.

  Example: 192.168.1.2/30

- virtualInterfaceState => (string)
  State of the virtual interface.
  - Confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.
  - Verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.
  - Pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.
  - Available: A virtual interface that is able to forward traffic.
  - Deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.
  - Deleted: A virtual interface that cannot forward traffic.
  - Rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the 'Confirming' state is deleted by the virtual interface owner, the virtual interface will enter the 'Rejected' state.
- customerRouterConfig => (string)

  Information for generating the customer router configuration.

- virtualGatewayId => (string)

  The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces.

  Example: vgw-123er56

- routeFilterPrefixes => (array<associative-array>)

  A list of routes to be advertised to the AWS network in this region (public virtual interface) or your VPC (private virtual interface).

  - (associative-array)

    A route filter prefix that the customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.

    - cidr => (string)

      CIDR notation for the advertised route. Multiple routes are separated by commas.

      Example: 10.10.10.0/24,10.10.11.0/24

# `public `Guzzle\Service\Resource\Model``
`confirmConnection( array $args = array() )`

Executes the ConfirmConnection operation.

Confirm the creation of a hosted connection on an interconnect.

Upon creation, the hosted connection is initially in the 'Ordering' state, and will remain in this state until the owner calls ConfirmConnection to confirm creation of the hosted connection.

#### Examples

- Basic formatting example

      $result = $client->confirmConnection(array(
          // connectionId is required
          'connectionId' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - connectionId => (string)

    ID of the connection.

    Example: dxcon-fg5678gh

    Default: None

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- connectionState => (string)
  State of the connection.
  - Ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
  - Requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
  - Pending: The connection has been approved, and is being initialized.
  - Available: The network link is up, and the connection is ready for use.
  - Down: The network link is down.
  - Deleted: The connection has been deleted.
  - Rejected: A hosted connection in the 'Ordering' state will enter the 'Rejected' state if it is deleted by the end customer.

# `public `Guzzle\Service\Resource\Model``
`confirmPrivateVirtualInterface( array $args = array() )`

Executes the ConfirmPrivateVirtualInterface operation.

Accept ownership of a private virtual interface created by another customer.

After the virtual interface owner calls this function, the virtual interface will be created and attached to the given virtual private gateway, and will be available for handling traffic.

#### Examples

- Basic formatting example

      $result = $client->confirmPrivateVirtualInterface(array(
          // virtualInterfaceId is required
          'virtualInterfaceId' => 'string',
          // virtualGatewayId is required
          'virtualGatewayId' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - virtualInterfaceId => (string)

    ID of the virtual interface.

    Example: dxvif-123dfg56

    Default: None

  - virtualGatewayId => (string)

    ID of the virtual private gateway that will be attached to the virtual interface.

    A virtual private gateway can be managed via the Amazon Virtual Private Cloud (VPC) console or the EC2 CreateVpnGateway action.

    Default: None

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- virtualInterfaceState => (string)
  State of the virtual interface.
  - Confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.
  - Verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.
  - Pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.
  - Available: A virtual interface that is able to forward traffic.
  - Deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.
  - Deleted: A virtual interface that cannot forward traffic.
  - Rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the 'Confirming' state is deleted by the virtual interface owner, the virtual interface will enter the 'Rejected' state.

# `public `Guzzle\Service\Resource\Model``
`confirmPublicVirtualInterface( array $args = array() )`

Executes the ConfirmPublicVirtualInterface operation.

Accept ownership of a public virtual interface created by another customer.

After the virtual interface owner calls this function, the specified virtual interface will be created and made available for handling traffic.

#### Examples

- Basic formatting example

      $result = $client->confirmPublicVirtualInterface(array(
          // virtualInterfaceId is required
          'virtualInterfaceId' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - virtualInterfaceId => (string)

    ID of the virtual interface.

    Example: dxvif-123dfg56

    Default: None

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- virtualInterfaceState => (string)
  State of the virtual interface.
  - Confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.
  - Verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.
  - Pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.
  - Available: A virtual interface that is able to forward traffic.
  - Deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.
  - Deleted: A virtual interface that cannot forward traffic.
  - Rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the 'Confirming' state is deleted by the virtual interface owner, the virtual interface will enter the 'Rejected' state.

# `public `Guzzle\Service\Resource\Model``
`createConnection( array $args = array() )`

Executes the CreateConnection operation.

Creates a new connection between the customer network and a specific AWS Direct Connect location.

A connection links your internal network to an AWS Direct Connect location over a standard 1 gigabit or 10 gigabit Ethernet fiber-optic cable. One end of the cable is connected to your router, the other to an AWS Direct Connect router. An AWS Direct Connect location provides access to Amazon Web Services in the region it is associated with. You can establish connections with AWS Direct Connect locations in multiple regions, but a connection in one region does not provide connectivity to other regions.

#### Examples

- Basic formatting example

      $result = $client->createConnection(array(
          // location is required
          'location' => 'string',
          // bandwidth is required
          'bandwidth' => 'string',
          // connectionName is required
          'connectionName' => 'string',
      ));

- CreateConnection operation example

      $result = $client->createConnection(array(
          'bandwidth'      => '1Gbps',
          'connectionName' => 'PHPTest',
          'location'       => 'EqDC2'
      ));

      $connectionId = $result['connectionId'];

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - location => (string)

    Where the connection is located.

    Example: EqSV5

    Default: None

  - bandwidth => (string)

    Bandwidth of the connection.

    Example: 1Gbps

    Default: None

  - connectionName => (string)

    The name of the connection.

    Example: "My Connection to AWS"

    Default: None

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- ownerAccount => (string)
- connectionId => (string)

  ID of the connection.

  Example: dxcon-fg5678gh

  Default: None

- connectionName => (string)

  The name of the connection.

  Example: "My Connection to AWS"

  Default: None

- connectionState => (string)
  State of the connection.
  - Ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
  - Requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
  - Pending: The connection has been approved, and is being initialized.
  - Available: The network link is up, and the connection is ready for use.
  - Down: The network link is down.
  - Deleted: The connection has been deleted.
  - Rejected: A hosted connection in the 'Ordering' state will enter the 'Rejected' state if it is deleted by the end customer.
- region => (string)

  The AWS region where the connection is located.

  Example: us-east-1

  Default: None

- location => (string)

  Where the connection is located.

  Example: EqSV5

  Default: None

- bandwidth => (string)

  Bandwidth of the connection.

  Example: 1Gbps (for regular connections), or 500Mbps (for hosted connections)

  Default: None

- vlan => (int)

  The VLAN ID.

  Example: 101

- partnerName => (string)

# `public `Guzzle\Service\Resource\Model``
`createInterconnect( array $args = array() )`

Executes the CreateInterconnect operation.

Creates a new interconnect between a AWS Direct Connect partner's network and a specific AWS Direct Connect location.

An interconnect is a connection which is capable of hosting other connections. The AWS Direct Connect partner can use an interconnect to provide sub-1Gbps AWS Direct Connect service to tier 2 customers who do not have their own connections. Like a standard connection, an interconnect links the AWS Direct Connect partner's network to an AWS Direct Connect location over a standard 1 Gbps or 10 Gbps Ethernet fiber-optic cable. One end is connected to the partner's router, the other to an AWS Direct Connect router.

For each end customer, the AWS Direct Connect partner provisions a connection on their interconnect by calling AllocateConnectionOnInterconnect. The end customer can then connect to AWS resources by creating a virtual interface on their connection, using the VLAN assigned to them by the AWS Direct Connect partner.

#### Examples

- Basic formatting example

      $result = $client->createInterconnect(array(
          // interconnectName is required
          'interconnectName' => 'string',
          // bandwidth is required
          'bandwidth' => 'string',
          // location is required
          'location' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - interconnectName => (string)

    The name of the interconnect.

    Example: "1G Interconnect to AWS"

    Default: None

  - bandwidth => (string)

    The port bandwidth

    Example: 1Gbps

    Default: None

    Available values: 1Gbps,10Gbps

  - location => (string)

    Where the interconnect is located

    Example: EqSV5

    Default: None

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- interconnectId => (string)

  The ID of the interconnect.

  Example: dxcon-abc123

- interconnectName => (string)

  The name of the interconnect.

  Example: "1G Interconnect to AWS"

- interconnectState => (string)
  State of the interconnect.
  - Requested: The initial state of an interconnect. The interconnect stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
  - Pending: The interconnect has been approved, and is being initialized.
  - Available: The network link is up, and the interconnect is ready for use.
  - Down: The network link is down.
  - Deleted: The interconnect has been deleted.
- region => (string)

  The AWS region where the connection is located.

  Example: us-east-1

  Default: None

- location => (string)

  Where the connection is located.

  Example: EqSV5

  Default: None

- bandwidth => (string)

  Bandwidth of the connection.

  Example: 1Gbps

  Default: None

# `public `Guzzle\Service\Resource\Model``
`createPrivateVirtualInterface( array $args = array() )`

Executes the CreatePrivateVirtualInterface operation.

Creates a new private virtual interface. A virtual interface is the VLAN that transports AWS Direct Connect traffic. A private virtual interface supports sending traffic to a single virtual private cloud (VPC).

#### Examples

- Basic formatting example

      $result = $client->createPrivateVirtualInterface(array(
          // connectionId is required
          'connectionId' => 'string',
          // newPrivateVirtualInterface is required
          'newPrivateVirtualInterface' => array(
              // virtualInterfaceName is required
              'virtualInterfaceName' => 'string',
              // vlan is required
              'vlan' => integer,
              // asn is required
              'asn' => integer,
              'authKey' => 'string',
              'amazonAddress' => 'string',
              'customerAddress' => 'string',
              // virtualGatewayId is required
              'virtualGatewayId' => 'string',
          ),
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - connectionId => (string)

    ID of the connection.

    Example: dxcon-fg5678gh

    Default: None

  - newPrivateVirtualInterface => (associative-array)

    Detailed information for the private virtual interface to be created.

    Default: None

    - virtualInterfaceName => (string)

      The name of the virtual interface assigned by the customer.

      Example: "My VPC"

    - vlan => (int)

      The VLAN ID.

      Example: 101

    - asn => (int)

      Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

      Example: 65000

    - authKey => (string)

      Authentication key for BGP configuration.

      Example: asdf34example

    - amazonAddress => (string)

      IP address assigned to the Amazon interface.

      Example: 192.168.1.1/30

    - customerAddress => (string)

      IP address assigned to the customer interface.

      Example: 192.168.1.2/30

    - virtualGatewayId => (string)

      The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces.

      Example: vgw-123er56

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- ownerAccount => (string)
- virtualInterfaceId => (string)

  ID of the virtual interface.

  Example: dxvif-123dfg56

  Default: None

- location => (string)

  Where the connection is located.

  Example: EqSV5

  Default: None

- connectionId => (string)

  ID of the connection.

  Example: dxcon-fg5678gh

  Default: None

- virtualInterfaceType => (string)

  The type of virtual interface.

  Example: private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, and so on.)

- virtualInterfaceName => (string)

  The name of the virtual interface assigned by the customer.

  Example: "My VPC"

- vlan => (int)

  The VLAN ID.

  Example: 101

- asn => (int)

  Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

  Example: 65000

- authKey => (string)

  Authentication key for BGP configuration.

  Example: asdf34example

- amazonAddress => (string)

  IP address assigned to the Amazon interface.

  Example: 192.168.1.1/30

- customerAddress => (string)

  IP address assigned to the customer interface.

  Example: 192.168.1.2/30

- virtualInterfaceState => (string)
  State of the virtual interface.
  - Confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.
  - Verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.
  - Pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.
  - Available: A virtual interface that is able to forward traffic.
  - Deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.
  - Deleted: A virtual interface that cannot forward traffic.
  - Rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the 'Confirming' state is deleted by the virtual interface owner, the virtual interface will enter the 'Rejected' state.
- customerRouterConfig => (string)

  Information for generating the customer router configuration.

- virtualGatewayId => (string)

  The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces.

  Example: vgw-123er56

- routeFilterPrefixes => (array<associative-array>)

  A list of routes to be advertised to the AWS network in this region (public virtual interface) or your VPC (private virtual interface).

  - (associative-array)

    A route filter prefix that the customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.

    - cidr => (string)

      CIDR notation for the advertised route. Multiple routes are separated by commas.

      Example: 10.10.10.0/24,10.10.11.0/24

# `public `Guzzle\Service\Resource\Model``
`createPublicVirtualInterface( array $args = array() )`

Executes the CreatePublicVirtualInterface operation.

Creates a new public virtual interface. A virtual interface is the VLAN that transports AWS Direct Connect traffic. A public virtual interface supports sending traffic to public services of AWS such as Amazon Simple Storage Service (Amazon S3).

#### Examples

- Basic formatting example

      $result = $client->createPublicVirtualInterface(array(
          // connectionId is required
          'connectionId' => 'string',
          // newPublicVirtualInterface is required
          'newPublicVirtualInterface' => array(
              // virtualInterfaceName is required
              'virtualInterfaceName' => 'string',
              // vlan is required
              'vlan' => integer,
              // asn is required
              'asn' => integer,
              'authKey' => 'string',
              // amazonAddress is required
              'amazonAddress' => 'string',
              // customerAddress is required
              'customerAddress' => 'string',
              // routeFilterPrefixes is required
              'routeFilterPrefixes' => array(
                  array(
                      'cidr' => 'string',
                  ),
                  // ... repeated
              ),
          ),
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - connectionId => (string)

    ID of the connection.

    Example: dxcon-fg5678gh

    Default: None

  - newPublicVirtualInterface => (associative-array)

    Detailed information for the public virtual interface to be created.

    Default: None

    - virtualInterfaceName => (string)

      The name of the virtual interface assigned by the customer.

      Example: "My VPC"

    - vlan => (int)

      The VLAN ID.

      Example: 101

    - asn => (int)

      Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

      Example: 65000

    - authKey => (string)

      Authentication key for BGP configuration.

      Example: asdf34example

    - amazonAddress => (string)

      IP address assigned to the Amazon interface.

      Example: 192.168.1.1/30

    - customerAddress => (string)

      IP address assigned to the customer interface.

      Example: 192.168.1.2/30

    - routeFilterPrefixes => (array<associative-array>)

      A list of routes to be advertised to the AWS network in this region (public virtual interface) or your VPC (private virtual interface).

      - (associative-array)

        A route filter prefix that the customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.

        - cidr => (string)

          CIDR notation for the advertised route. Multiple routes are separated by commas.

          Example: 10.10.10.0/24,10.10.11.0/24

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- ownerAccount => (string)
- virtualInterfaceId => (string)

  ID of the virtual interface.

  Example: dxvif-123dfg56

  Default: None

- location => (string)

  Where the connection is located.

  Example: EqSV5

  Default: None

- connectionId => (string)

  ID of the connection.

  Example: dxcon-fg5678gh

  Default: None

- virtualInterfaceType => (string)

  The type of virtual interface.

  Example: private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, and so on.)

- virtualInterfaceName => (string)

  The name of the virtual interface assigned by the customer.

  Example: "My VPC"

- vlan => (int)

  The VLAN ID.

  Example: 101

- asn => (int)

  Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

  Example: 65000

- authKey => (string)

  Authentication key for BGP configuration.

  Example: asdf34example

- amazonAddress => (string)

  IP address assigned to the Amazon interface.

  Example: 192.168.1.1/30

- customerAddress => (string)

  IP address assigned to the customer interface.

  Example: 192.168.1.2/30

- virtualInterfaceState => (string)
  State of the virtual interface.
  - Confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.
  - Verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.
  - Pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.
  - Available: A virtual interface that is able to forward traffic.
  - Deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.
  - Deleted: A virtual interface that cannot forward traffic.
  - Rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the 'Confirming' state is deleted by the virtual interface owner, the virtual interface will enter the 'Rejected' state.
- customerRouterConfig => (string)

  Information for generating the customer router configuration.

- virtualGatewayId => (string)

  The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces.

  Example: vgw-123er56

- routeFilterPrefixes => (array<associative-array>)

  A list of routes to be advertised to the AWS network in this region (public virtual interface) or your VPC (private virtual interface).

  - (associative-array)

    A route filter prefix that the customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.

    - cidr => (string)

      CIDR notation for the advertised route. Multiple routes are separated by commas.

      Example: 10.10.10.0/24,10.10.11.0/24

# `public `Guzzle\Service\Resource\Model``
`deleteConnection( array $args = array() )`

Executes the DeleteConnection operation.

Deletes the connection.

Deleting a connection only stops the AWS Direct Connect port hour and data transfer charges. You need to cancel separately with the providers any services or charges for cross-connects or network circuits that connect you to the AWS Direct Connect location.

#### Examples

- Basic formatting example

      $result = $client->deleteConnection(array(
          // connectionId is required
          'connectionId' => 'string',
      ));

- DeleteConnection operation example

      $result = $client->deleteConnection(array(
          'connectionId' => $connectionId
      ));

      echo $result['connectionState'];

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - connectionId => (string)

    ID of the connection.

    Example: dxcon-fg5678gh

    Default: None

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- ownerAccount => (string)
- connectionId => (string)

  ID of the connection.

  Example: dxcon-fg5678gh

  Default: None

- connectionName => (string)

  The name of the connection.

  Example: "My Connection to AWS"

  Default: None

- connectionState => (string)
  State of the connection.
  - Ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
  - Requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
  - Pending: The connection has been approved, and is being initialized.
  - Available: The network link is up, and the connection is ready for use.
  - Down: The network link is down.
  - Deleted: The connection has been deleted.
  - Rejected: A hosted connection in the 'Ordering' state will enter the 'Rejected' state if it is deleted by the end customer.
- region => (string)

  The AWS region where the connection is located.

  Example: us-east-1

  Default: None

- location => (string)

  Where the connection is located.

  Example: EqSV5

  Default: None

- bandwidth => (string)

  Bandwidth of the connection.

  Example: 1Gbps (for regular connections), or 500Mbps (for hosted connections)

  Default: None

- vlan => (int)

  The VLAN ID.

  Example: 101

- partnerName => (string)

# `public `Guzzle\Service\Resource\Model``
`deleteInterconnect( array $args = array() )`

Executes the DeleteInterconnect operation.

Deletes the specified interconnect.

#### Examples

- Basic formatting example

      $result = $client->deleteInterconnect(array(
          // interconnectId is required
          'interconnectId' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - interconnectId => (string)

    The ID of the interconnect.

    Example: dxcon-abc123

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- interconnectState => (string)
  State of the interconnect.
  - Requested: The initial state of an interconnect. The interconnect stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
  - Pending: The interconnect has been approved, and is being initialized.
  - Available: The network link is up, and the interconnect is ready for use.
  - Down: The network link is down.
  - Deleted: The interconnect has been deleted.

# `public `Guzzle\Service\Resource\Model``
`deleteVirtualInterface( array $args = array() )`

Executes the DeleteVirtualInterface operation.

Deletes a virtual interface.

#### Examples

- Basic formatting example

      $result = $client->deleteVirtualInterface(array(
          // virtualInterfaceId is required
          'virtualInterfaceId' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - virtualInterfaceId => (string)

    ID of the virtual interface.

    Example: dxvif-123dfg56

    Default: None

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- virtualInterfaceState => (string)
  State of the virtual interface.
  - Confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.
  - Verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.
  - Pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.
  - Available: A virtual interface that is able to forward traffic.
  - Deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.
  - Deleted: A virtual interface that cannot forward traffic.
  - Rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the 'Confirming' state is deleted by the virtual interface owner, the virtual interface will enter the 'Rejected' state.

# `public `Guzzle\Service\Resource\Model``
`describeConnections( array $args = array() )`

Executes the DescribeConnections operation.

Displays all connections in this region.

If a connection ID is provided, the call returns only that particular connection.

#### Examples

- Basic formatting example

      $result = $client->describeConnections(array(
          'connectionId' => 'string',
      ));

- DescribeConnections operation example

      $iterator = $client->getIterator('DescribeConnections');

      foreach ($iterator as $connection) {
          echo $connection['connectionId'] . "\n";
      }

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - connectionId => (string)

    ID of the connection.

    Example: dxcon-fg5678gh

    Default: None

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- connections => (array<associative-array>)

  A list of connections.

  - (associative-array)

    A connection represents the physical network connection between the AWS Direct Connect location and the customer.

    - ownerAccount => (string)
    - connectionId => (string)

      ID of the connection.

      Example: dxcon-fg5678gh

      Default: None

    - connectionName => (string)

      The name of the connection.

      Example: "My Connection to AWS"

      Default: None

    - connectionState => (string)
      State of the connection.
      - Ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
      - Requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
      - Pending: The connection has been approved, and is being initialized.
      - Available: The network link is up, and the connection is ready for use.
      - Down: The network link is down.
      - Deleted: The connection has been deleted.
      - Rejected: A hosted connection in the 'Ordering' state will enter the 'Rejected' state if it is deleted by the end customer.
    - region => (string)

      The AWS region where the connection is located.

      Example: us-east-1

      Default: None

    - location => (string)

      Where the connection is located.

      Example: EqSV5

      Default: None

    - bandwidth => (string)

      Bandwidth of the connection.

      Example: 1Gbps (for regular connections), or 500Mbps (for hosted connections)

      Default: None

    - vlan => (int)

      The VLAN ID.

      Example: 101

    - partnerName => (string)

# `public `Guzzle\Service\Resource\Model``
`describeConnectionsOnInterconnect( array $args = array() )`

Executes the DescribeConnectionsOnInterconnect operation.

Return a list of connections that have been provisioned on the given interconnect.

#### Examples

- Basic formatting example

      $result = $client->describeConnectionsOnInterconnect(array(
          // interconnectId is required
          'interconnectId' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - interconnectId => (string)

    ID of the interconnect on which a list of connection is provisioned.

    Example: dxcon-abc123

    Default: None

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- connections => (array<associative-array>)

  A list of connections.

  - (associative-array)

    A connection represents the physical network connection between the AWS Direct Connect location and the customer.

    - ownerAccount => (string)
    - connectionId => (string)

      ID of the connection.

      Example: dxcon-fg5678gh

      Default: None

    - connectionName => (string)

      The name of the connection.

      Example: "My Connection to AWS"

      Default: None

    - connectionState => (string)
      State of the connection.
      - Ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
      - Requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
      - Pending: The connection has been approved, and is being initialized.
      - Available: The network link is up, and the connection is ready for use.
      - Down: The network link is down.
      - Deleted: The connection has been deleted.
      - Rejected: A hosted connection in the 'Ordering' state will enter the 'Rejected' state if it is deleted by the end customer.
    - region => (string)

      The AWS region where the connection is located.

      Example: us-east-1

      Default: None

    - location => (string)

      Where the connection is located.

      Example: EqSV5

      Default: None

    - bandwidth => (string)

      Bandwidth of the connection.

      Example: 1Gbps (for regular connections), or 500Mbps (for hosted connections)

      Default: None

    - vlan => (int)

      The VLAN ID.

      Example: 101

    - partnerName => (string)

# `public `Guzzle\Service\Resource\Model``
`describeInterconnects( array $args = array() )`

Executes the DescribeInterconnects operation.

Returns a list of interconnects owned by the AWS account.

If an interconnect ID is provided, it will only return this particular interconnect.

#### Examples

- Basic formatting example

      $result = $client->describeInterconnects(array(
          'interconnectId' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - interconnectId => (string)

    The ID of the interconnect.

    Example: dxcon-abc123

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- interconnects => (array<associative-array>)

  A list of interconnects.

  - (associative-array)

    An interconnect is a connection that can host other connections.

    Like a standard AWS Direct Connect connection, an interconnect represents the physical connection between an AWS Direct Connect partner's network and a specific Direct Connect location. An AWS Direct Connect partner who owns an interconnect can provision hosted connections on the interconnect for their end customers, thereby providing the end customers with connectivity to AWS services.

    The resources of the interconnect, including bandwidth and VLAN numbers, are shared by all of the hosted connections on the interconnect, and the owner of the interconnect determines how these resources are assigned.

    - interconnectId => (string)

      The ID of the interconnect.

      Example: dxcon-abc123

    - interconnectName => (string)

      The name of the interconnect.

      Example: "1G Interconnect to AWS"

    - interconnectState => (string)
      State of the interconnect.
      - Requested: The initial state of an interconnect. The interconnect stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
      - Pending: The interconnect has been approved, and is being initialized.
      - Available: The network link is up, and the interconnect is ready for use.
      - Down: The network link is down.
      - Deleted: The interconnect has been deleted.
    - region => (string)

      The AWS region where the connection is located.

      Example: us-east-1

      Default: None

    - location => (string)

      Where the connection is located.

      Example: EqSV5

      Default: None

    - bandwidth => (string)

      Bandwidth of the connection.

      Example: 1Gbps

      Default: None

# `public `Guzzle\Service\Resource\Model``
`describeLocations( array $args = array() )`

Executes the DescribeLocations operation.

Returns the list of AWS Direct Connect locations in the current AWS region. These are the locations that may be selected when calling CreateConnection or CreateInterconnect.

#### Examples

- Basic formatting example

      $result = $client->describeLocations(array(
      ));

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- locations => (array<associative-array>)
  - (associative-array)

    An AWS Direct Connect location where connections and interconnects can be requested.

    - locationCode => (string)

      The code used to indicate the AWS Direct Connect location.

    - locationName => (string)

      The name of the AWS Direct Connect location. The name includes the colocation partner name and the physical site of the lit building.

# `public `Guzzle\Service\Resource\Model``
`describeVirtualGateways( array $args = array() )`

Executes the DescribeVirtualGateways operation.

Returns a list of virtual private gateways owned by the AWS account.

You can create one or more AWS Direct Connect private virtual interfaces linking to a virtual private gateway. A virtual private gateway can be managed via Amazon Virtual Private Cloud (VPC) console or the EC2 CreateVpnGateway action.

#### Examples

- Basic formatting example

      $result = $client->describeVirtualGateways(array(
      ));

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- virtualGateways => (array<associative-array>)

  A list of virtual private gateways.

  - (associative-array)

    You can create one or more AWS Direct Connect private virtual interfaces linking to your virtual private gateway.

    Virtual private gateways can be managed using the Amazon Virtual Private Cloud (Amazon VPC) console or the Amazon EC2 CreateVpnGateway action.

    - virtualGatewayId => (string)

      The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces.

      Example: vgw-123er56

    - virtualGatewayState => (string)
      State of the virtual private gateway.
      - Pending: This is the initial state after calling CreateVpnGateway.
      - Available: Ready for use by a private virtual interface.
      - Deleting: This is the initial state after calling DeleteVpnGateway.
      - Deleted: In this state, a private virtual interface is unable to send traffic over this gateway.

# `public `Guzzle\Service\Resource\Model``
`describeVirtualInterfaces( array $args = array() )`

Executes the DescribeVirtualInterfaces operation.

Displays all virtual interfaces for an AWS account. Virtual interfaces deleted fewer than 15 minutes before DescribeVirtualInterfaces is called are also returned. If a connection ID is included then only virtual interfaces associated with this connection will be returned. If a virtual interface ID is included then only a single virtual interface will be returned.

A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer.

If a connection ID is provided, only virtual interfaces provisioned on the specified connection will be returned. If a virtual interface ID is provided, only this particular virtual interface will be returned.

#### Examples

- Basic formatting example

      $result = $client->describeVirtualInterfaces(array(
          'connectionId' => 'string',
          'virtualInterfaceId' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - connectionId => (string)

    ID of the connection.

    Example: dxcon-fg5678gh

    Default: None

  - virtualInterfaceId => (string)

    ID of the virtual interface.

    Example: dxvif-123dfg56

    Default: None

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- virtualInterfaces => (array<associative-array>)

  A list of virtual interfaces.

  - (associative-array)

    A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer.

    - ownerAccount => (string)
    - virtualInterfaceId => (string)

      ID of the virtual interface.

      Example: dxvif-123dfg56

      Default: None

    - location => (string)

      Where the connection is located.

      Example: EqSV5

      Default: None

    - connectionId => (string)

      ID of the connection.

      Example: dxcon-fg5678gh

      Default: None

    - virtualInterfaceType => (string)

      The type of virtual interface.

      Example: private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, and so on.)

    - virtualInterfaceName => (string)

      The name of the virtual interface assigned by the customer.

      Example: "My VPC"

    - vlan => (int)

      The VLAN ID.

      Example: 101

    - asn => (int)

      Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

      Example: 65000

    - authKey => (string)

      Authentication key for BGP configuration.

      Example: asdf34example

    - amazonAddress => (string)

      IP address assigned to the Amazon interface.

      Example: 192.168.1.1/30

    - customerAddress => (string)

      IP address assigned to the customer interface.

      Example: 192.168.1.2/30

    - virtualInterfaceState => (string)
      State of the virtual interface.
      - Confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.
      - Verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.
      - Pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.
      - Available: A virtual interface that is able to forward traffic.
      - Deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.
      - Deleted: A virtual interface that cannot forward traffic.
      - Rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the 'Confirming' state is deleted by the virtual interface owner, the virtual interface will enter the 'Rejected' state.
    - customerRouterConfig => (string)

      Information for generating the customer router configuration.

    - virtualGatewayId => (string)

      The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces.

      Example: vgw-123er56

    - routeFilterPrefixes => (array<associative-array>)

      A list of routes to be advertised to the AWS network in this region (public virtual interface) or your VPC (private virtual interface).

      - (associative-array)

        A route filter prefix that the customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.

        - cidr => (string)

          CIDR notation for the advertised route. Multiple routes are separated by commas.

          Example: 10.10.10.0/24,10.10.11.0/24

# `public `Guzzle\Service\Resource\ResourceIteratorInterface``
`getDescribeConnectionsIterator( array $args = array() )`

The input array uses the parameters of the DescribeConnections operation

#### Parameters

$args
  `array`
  $args

#### Returns

``Guzzle\Service\Resource\ResourceIteratorInterface``
# `public `Guzzle\Service\Resource\ResourceIteratorInterface``
`getDescribeConnectionsOnInterconnectIterator( array $args = array() )`

The input array uses the parameters of the DescribeConnectionsOnInterconnect operation

#### Parameters

$args
  `array`
  $args

#### Returns

``Guzzle\Service\Resource\ResourceIteratorInterface``
# `public `Guzzle\Service\Resource\ResourceIteratorInterface``
`getDescribeInterconnectsIterator( array $args = array() )`

The input array uses the parameters of the DescribeInterconnects operation

#### Parameters

$args
  `array`
  $args

#### Returns

``Guzzle\Service\Resource\ResourceIteratorInterface``
# `public `Guzzle\Service\Resource\ResourceIteratorInterface``
`getDescribeLocationsIterator( array $args = array() )`

The input array uses the parameters of the DescribeLocations operation

#### Parameters

$args
  `array`
  $args

#### Returns

``Guzzle\Service\Resource\ResourceIteratorInterface``
# `public `Guzzle\Service\Resource\ResourceIteratorInterface``
`getDescribeVirtualGatewaysIterator( array $args = array() )`

The input array uses the parameters of the DescribeVirtualGateways operation

#### Parameters

$args
  `array`
  $args

#### Returns

``Guzzle\Service\Resource\ResourceIteratorInterface``
# `public `Guzzle\Service\Resource\ResourceIteratorInterface``
`getDescribeVirtualInterfacesIterator( array $args = array() )`

The input array uses the parameters of the DescribeVirtualInterfaces operation

#### Parameters

$args
  `array`
  $args

#### Returns

``Guzzle\Service\Resource\ResourceIteratorInterface``

### Methods inherited from Aws\Common\Client\AbstractClient

`__call()`, `__construct()`, `createRequest()`, `getAllEvents()`, `getApiVersion()`, `getCredentials()`, `getRegion()`, `getRegions()`, `getSignature()`, `getWaiter()`, `getWaiterFactory()`, `send()`, `setCredentials()`, `setRegion()`, `setWaiterFactory()`, `waitUntil()`

### Methods inherited from Guzzle\Service\Client

`execute()`, `executeMultiple()`, `getCommand()`, `getCommandFactory()`, `getDescription()`, `getInflector()`, `getIterator()`, `getResourceIteratorFactory()`, `prepareCommand()`, `setCommandFactory()`, `setDescription()`, `setInflector()`, `setResourceIteratorFactory()`

### Methods inherited from Guzzle\Http\Client

`delete()`, `expandTemplate()`, `extractPharCacert()`, `get()`, `getBaseUrl()`, `getConfig()`, `getCurlMulti()`, `getDefaultOption()`, `getDefaultUserAgent()`, `getUriTemplate()`, `head()`, `initSsl()`, `options()`, `patch()`, `post()`, `prepareRequest()`, `put()`, `sendMultiple()`, `setBaseUrl()`, `setConfig()`, `setCurlMulti()`, `setDefaultOption()`, `setRequestFactory()`, `setSslVerification()`, `setUriTemplate()`, `setUserAgent()`

### Methods inherited from Guzzle\Common\AbstractHasDispatcher

`addSubscriber()`, `dispatch()`, `getEventDispatcher()`, `setEventDispatcher()`

### Magic methods summary

## Constants summary

`string` | `LATEST_API_VERSION` | `'2012-10-25'` | #

### Constants inherited from Guzzle\Service\Client

`COMMAND_PARAMS`

### Constants inherited from Guzzle\Http\Client

`CURL_OPTIONS`, `DEFAULT_SELECT_TIMEOUT`, `DISABLE_REDIRECTS`, `MAX_HANDLES`, `REQUEST_OPTIONS`, `SSL_CERT_AUTHORITY`

### Constants inherited from Guzzle\Http\ClientInterface

`CREATE_REQUEST`, `HTTP_DATE`

## Properties summary

### Properties inherited from Aws\Common\Client\AbstractClient

`$aggregator`, `$credentials`, `$signature`, `$waiterFactory`

### Properties inherited from Guzzle\Service\Client

`$commandFactory`, `$inflector`, `$resourceIteratorFactory`, `$serviceDescription`

### Properties inherited from Guzzle\Http\Client

`$defaultHeaders`, `$requestFactory`, `$userAgent`

### Properties inherited from Guzzle\Common\AbstractHasDispatcher

`$eventDispatcher`