@aws-sdk/client-direct-connect

Description

AWS SDK for JavaScript DirectConnect Client for Node.js, Browser and React Native.

Direct Connect links your internal network to an Direct Connect location over a standard Ethernet fiber-optic cable.
One end of the cable is connected to your router, the other to an Direct Connect router. With this connection
in place, you can create virtual interfaces directly to the Amazon Web Services Cloud (for example, to Amazon EC2
and Amazon S3) and to Amazon VPC, bypassing Internet service providers in your network path. A
connection provides access to all Amazon Web Services Regions except the China (Beijing) and (China) Ningxia Regions.
Amazon Web Services resources in the China Regions can only be accessed through locations associated with those Regions.

Installing

To install this package, simply type add or install @aws-sdk/client-direct-connect
using your favorite package manager:
- npm install @aws-sdk/client-direct-connect
- yarn add @aws-sdk/client-direct-connect
- pnpm add @aws-sdk/client-direct-connect

Getting Started

$3

The AWS SDK is modulized by clients and commands.
To send a request, you only need to import the DirectConnectClient and
the commands you need, for example ListVirtualInterfaceTestHistoryCommand:

``js
// ES5 example
const { DirectConnectClient, ListVirtualInterfaceTestHistoryCommand } = require("@aws-sdk/client-direct-connect");
`

`ts
// ES6+ example
import { DirectConnectClient, ListVirtualInterfaceTestHistoryCommand } from "@aws-sdk/client-direct-connect";
`

$3

To send a request, you:

- Initiate client with configuration (e.g. credentials, region).
- Initiate command with input parameters.
- Call send operation on client with command object as input.
- If you are using a custom http handler, you may call destroy() to close open connections.

`js
// a client can be shared by different commands.
const client = new DirectConnectClient({ region: "REGION" });

const params = { /* input parameters / };
const command = new ListVirtualInterfaceTestHistoryCommand(params);
`

#### Async/await

We recommend using await
operator to wait for the promise returned by send operation as follows:

`js
// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}
`

Async-await is clean, concise, intuitive, easy to debug and has better error handling
as compared to using Promise chains or callbacks.

#### Promises

You can also use Promise chaining
to execute send operation.

`js
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
`

Promises can also be called using .catch() and .finally() as follows:

`js
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
`

#### Callbacks

We do not recommend using callbacks because of callback hell,
but they are supported by the send operation.

`js
// callbacks.
client.send(command, (err, data) => {
// process err and data.
});
`

#### v2 compatible style

The client can also send requests using v2 compatible style.
However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
on modular packages in AWS SDK for JavaScript

`ts
import * as AWS from "@aws-sdk/client-direct-connect";
const client = new AWS.DirectConnect({ region: "REGION" });

// async/await.
try {
const data = await client.listVirtualInterfaceTestHistory(params);
// process data.
} catch (error) {
// error handling.
}

// Promises.
client
.listVirtualInterfaceTestHistory(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});

// callbacks.
client.listVirtualInterfaceTestHistory(params, (err, data) => {
// process err and data.
});
`

$3

When the service returns an exception, the error will include the exception information,
as well as response metadata (e.g. request id).

`js
try {
const data = await client.send(command);
// process data.
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
/**
* The keys within exceptions are also parsed.
* You can access them by specifying exception names:
* if (error.name === 'SomeServiceException') {
* const value = error.specialKeyInException;
* }
*/
}
`

Getting Help

Please use these community resources for getting help.
We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

- Visit Developer Guide
or API Reference.
- Check out the blog posts tagged with aws-sdk-js
on AWS Developer Blog.
- Ask a question on StackOverflow and tag it with aws-sdk-js.
- Join the AWS JavaScript community on gitter.
- If it turns out that you may have found a bug, please open an issue.

To test your universal JavaScript code in Node.js, browser and react-native environments,
visit our code samples repo.

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-direct-connect` package is updated.
To contribute to client you can check our generate clients scripts.

License

This SDK is distributed under the
Apache License, Version 2.0,
see LICENSE for more information.

Client Commands (Operations List)

AcceptDirectConnectGatewayAssociationProposal

Command API Reference / Input / Output

AllocateConnectionOnInterconnect

Command API Reference / Input / Output

AllocateHostedConnection

Command API Reference / Input / Output

AllocatePrivateVirtualInterface

Command API Reference / Input / Output

AllocatePublicVirtualInterface

Command API Reference / Input / Output

AllocateTransitVirtualInterface

Command API Reference / Input / Output

AssociateConnectionWithLag

Command API Reference / Input / Output

AssociateHostedConnection

Command API Reference / Input / Output

AssociateMacSecKey

Command API Reference / Input / Output

AssociateVirtualInterface

Command API Reference / Input / Output

ConfirmConnection

Command API Reference / Input / Output

ConfirmCustomerAgreement

Command API Reference / Input / Output

ConfirmPrivateVirtualInterface

Command API Reference / Input / Output

ConfirmPublicVirtualInterface

Command API Reference / Input / Output

ConfirmTransitVirtualInterface

Command API Reference / Input / Output

CreateBGPPeer

Command API Reference / Input / Output

CreateConnection

Command API Reference / Input / Output

CreateDirectConnectGateway

Command API Reference / Input / Output

CreateDirectConnectGatewayAssociation

Command API Reference / Input / Output

CreateDirectConnectGatewayAssociationProposal

Command API Reference / Input / Output

CreateInterconnect

Command API Reference / Input / Output

CreateLag

Command API Reference / Input / Output

CreatePrivateVirtualInterface

Command API Reference / Input / Output

CreatePublicVirtualInterface

Command API Reference / Input / Output

CreateTransitVirtualInterface

Command API Reference / Input / Output

DeleteBGPPeer

Command API Reference / Input / Output

DeleteConnection

Command API Reference / Input / Output

DeleteDirectConnectGateway

Command API Reference / Input / Output

DeleteDirectConnectGatewayAssociation

Command API Reference / Input / Output

DeleteDirectConnectGatewayAssociationProposal

Command API Reference / Input / Output

DeleteInterconnect

Command API Reference / Input / Output

DeleteLag

Command API Reference / Input / Output

DeleteVirtualInterface

Command API Reference / Input / Output

DescribeConnectionLoa

Command API Reference / Input / Output

DescribeConnections

Command API Reference / Input / Output

DescribeConnectionsOnInterconnect

Command API Reference / Input / Output

DescribeCustomerMetadata

Command API Reference / Input / Output

DescribeDirectConnectGatewayAssociationProposals

Command API Reference / Input / Output

DescribeDirectConnectGatewayAssociations

Command API Reference / Input / Output

DescribeDirectConnectGatewayAttachments

Command API Reference / Input / Output

DescribeDirectConnectGateways

Command API Reference / Input / Output

DescribeHostedConnections

Command API Reference / Input / Output

DescribeInterconnectLoa

Command API Reference / Input / Output

DescribeInterconnects

Command API Reference / Input / Output

DescribeLags

Command API Reference / Input / Output

DescribeLoa

Command API Reference / Input / Output

DescribeLocations

Command API Reference / Input / Output

DescribeRouterConfiguration

Command API Reference / Input / Output

DescribeTags

Command API Reference / Input / Output

DescribeVirtualGateways

Command API Reference / Input / Output

DescribeVirtualInterfaces

Command API Reference / Input / Output

DisassociateConnectionFromLag

Command API Reference / Input / Output

DisassociateMacSecKey

Command API Reference / Input / Output

ListVirtualInterfaceTestHistory

Command API Reference / Input / Output

StartBgpFailoverTest

Command API Reference / Input / Output

StopBgpFailoverTest

Command API Reference / Input / Output

TagResource

Command API Reference / Input / Output

UntagResource

Command API Reference / Input / Output

UpdateConnection

Command API Reference / Input / Output

UpdateDirectConnectGateway

Command API Reference / Input / Output

UpdateDirectConnectGatewayAssociation

Command API Reference / Input / Output

UpdateLag

Command API Reference / Input / Output

UpdateVirtualInterfaceAttributes

Command API Reference / Input / Output