> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tensor9.com/llms.txt
> Use this file to discover all available pages before exploring further.

# AWS JavaScript and TypeScript SDK Guide

> Configure AWS SDK for JavaScript v3 to call a Cloud Adapter endpoint.

Use the normal AWS commands and response types, but construct the client with the Cloud Adapter endpoint. The example below uses AWS SDK for JavaScript v3 and S3.

## Start a local adapter

This guide's bounded example uses S3 backed by Google Cloud Storage:

**1. Install or update the Tensor9 CLI**

Install the customer CLI with Homebrew, then confirm the binary is available:

```bash theme={null}
brew tap tensor9ine/tensor9
brew trust tensor9ine/tensor9
brew install tensor9
tensor9 --version
```

If `tensor9` is already installed, run `brew upgrade tensor9` instead of the install command.

**2. Authenticate with Tensor9**

To create a Tensor9 account and download an API key yourself, follow [Get a Tensor9 API key](https://docs.tensor9.com/byoc/getting-started/api-key.md).

A Tensor9 API key is required. Use the key issued during onboarding, or email [hello@tensor9.com](mailto:hello@tensor9.com) to request one for your organization. Do not share your account or key with another customer or organization.

If your secret manager has already supplied `T9_API_KEY`, skip the prompt. Otherwise, enter your key at a hidden prompt in the terminal where you will run `tensor9`:

> [tab] Bash
>
> ```bash theme={null}
> set +x
> IFS= read -r -s -p 'Tensor9 API key: ' T9_API_KEY
> printf '\n'
> export T9_API_KEY
> ```

> [tab] Zsh
>
> ```zsh theme={null}
> set +x
> IFS= read -r -s 'T9_API_KEY?Tensor9 API key: '
> printf '\n'
> export T9_API_KEY
> ```

Check that the variable is set without printing it, then verify your Tensor9 identity:

```bash theme={null}
: "${T9_API_KEY:?Set T9_API_KEY before continuing}"
tensor9 whoami
```

Confirm that the reported identity belongs to the intended customer account. Do not continue if authentication fails or the account is wrong. While `T9_API_KEY` is set, `tensor9` commands in this terminal use the key instead of any controller profile, so use a separate terminal for this work and run `unset T9_API_KEY` when you finish. Keep shell tracing disabled while using the key. Do not paste the key into commands, shell profiles, source files, screenshots or support messages.

See [Install and Authenticate](https://docs.tensor9.com/cloud-adapter-early-access/getting-started/install-and-authenticate.md) for the planned license lifecycle, entitlements and credential boundaries.

**3. Inspect the S3 to Google Cloud Storage mapping**

Ask Tensor9 to describe the exact directed service mapping used by this guide:

```bash theme={null}
tensor9 explain \
  -origin aws::1.0.0::s3 \
  -target google::1.0.0::gcs \
  -fmt Human
```

Read the supported S3 operations and Google Cloud Storage limitations before starting the process. The mapping is directional: this command describes S3 requests adapted to Google Cloud Storage, not the reverse direction.

**4. Prepare Google Cloud access**

Authenticate with Google Cloud using its standard Application Default Credentials chain. The adapter uses that identity when it calls Google Cloud Storage.

Use a dedicated test project and narrowly scoped credentials. Do not put credentials in the command line, source code, or screenshots.

**5. Start the S3 service adapter**

Run the S3 to Google Cloud Storage adapter as a foreground process:

```bash theme={null}
tensor9 adapt svc run \
  --origin aws::1.0.0::s3 \
  --backend google::1.0.0::gcs
```

Leave this terminal open. This is the current foreground launcher, not the pending Docker launcher for [local development mode](https://docs.tensor9.com/cloud-adapter-early-access/deployment/single-binary.md). It calls your actual target-cloud services; it is separate from the in-memory emulator. Acquisition and license renewal require Tensor9 authentication. Keep the endpoint local to your test.

**6. Copy the listening endpoint**

When the command reports its listening endpoint, copy that exact value into a second terminal:

```bash theme={null}
export T9_CLOUD_ADAPTER_ENDPOINT="<endpoint printed by tensor9>"
```

Keep the endpoint local to the test unless you have deliberately configured network access and authentication for another machine.

**7. Run one bounded S3 request**

Continue with this page's client or tool instructions. Point only S3 at `T9_CLOUD_ADAPTER_ENDPOINT`, then perform one operation whose Google Cloud Storage effect you can verify independently.

Check both sides: read the S3-shaped response and inspect the native object or bucket in Google Cloud Storage. A successful client response alone does not prove that the target state is correct.

**8. Stop the local adapter**

Return to the first terminal and press **Control-C**. Confirm the process exits before deleting the test object or bucket with Google Cloud's native client.

If the request failed, preserve the request ID, adapter endpoint, S3 operation name, Google Cloud request ID, and any `x-t9-explain-*` receipt headers before stopping the process.

## Choose how to set the endpoint

### Set it for the process

```bash theme={null}
export AWS_ENDPOINT_URL_S3="$T9_CLOUD_ADAPTER_ENDPOINT"
```

AWS SDK for JavaScript v3 reads that service-specific setting when the client has no explicit `endpoint`:

```ts theme={null}
import { S3Client } from "@aws-sdk/client-s3";
import { fromIni } from "@aws-sdk/credential-providers";

const client = new S3Client({
  region: process.env.AWS_REGION ?? "us-east-1",
  credentials: fromIni({ profile: "adapter-test" }),
  forcePathStyle: true,
  maxAttempts: 3,
});
```

### Set it on one client

```bash theme={null}
: "${T9_CLOUD_ADAPTER_ENDPOINT:?start the local adapter and copy its endpoint first}"
```

```ts theme={null}
import { fromIni } from "@aws-sdk/credential-providers";
import {
  DeleteObjectCommand,
  GetObjectCommand,
  HeadObjectCommand,
  PutObjectCommand,
  S3Client,
} from "@aws-sdk/client-s3";

const client = new S3Client({
  endpoint: process.env.T9_CLOUD_ADAPTER_ENDPOINT,
  region: process.env.AWS_REGION ?? "us-east-1",
  credentials: fromIni({ profile: "adapter-test" }),
  forcePathStyle: true,
  maxAttempts: 3,
});
```

Keep this endpoint decision in dependency injection or a client factory. Do not make every call site know whether it is talking to AWS or Cloud Adapter.

The explicit `endpoint` wins when `AWS_ENDPOINT_URL_S3` is also set. Avoid setting both to different values.

For SDK v2, use the v2 client's `endpoint` and `s3ForcePathStyle` settings. Avoid silently selecting different endpoint behavior during a v2-to-v3 migration.

## Exercise create, read, compare, and delete

```ts theme={null}
const bucket = process.env.TEST_BUCKET!;
const key = `typescript/${Date.now()}-hello.txt`;
const expected = Buffer.from("hello through Cloud Adapter\n");

await client.send(new PutObjectCommand({
  Bucket: bucket,
  Key: key,
  Body: expected,
  ContentType: "text/plain",
}));
await client.send(new HeadObjectCommand({ Bucket: bucket, Key: key }));

const response = await client.send(new GetObjectCommand({ Bucket: bucket, Key: key }));
const actual = Buffer.from(await response.Body!.transformToByteArray());
if (!actual.equals(expected)) throw new Error("Object bytes changed in transit");

await client.send(new DeleteObjectCommand({ Bucket: bucket, Key: key }));
```

After the write, inspect the native target object. Confirm the target name, content type, metadata, and bytes.

## Log useful failures safely

AWS SDK v3 service exceptions include `$metadata`:

```ts theme={null}
try {
  await client.send(new HeadObjectCommand({ Bucket: bucket, Key: "missing-key" }));
} catch (error: any) {
  console.error({
    name: error.name,
    message: error.message,
    status: error.$metadata?.httpStatusCode,
    requestId: error.$metadata?.requestId,
    attempts: error.$metadata?.attempts,
  });
}
```

Do not log the complete request object, authorization headers, signed URLs, or response bodies. For a timeout after a mutation, inspect the target before retrying.

## Test what your application actually uses

The basic lifecycle does not certify paginators, multipart upload, conditional headers, presigned URLs, tags, version IDs, or retries. Add each feature to an integration test and compare it with the target-specific behavior on the [S3 service page](https://docs.tensor9.com/cloud-adapter-early-access/service-catalog/aws/databases-storage/s3.md).

Use [Testing Your Adapters](https://docs.tensor9.com/cloud-adapter-early-access/local-testing/testing-your-adapters.md) for repeatable tests and [Debugging Your Adapters](https://docs.tensor9.com/cloud-adapter-early-access/debugging/overview.md) for translated errors.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.