> ## Documentation Index
> Fetch the complete documentation index at: https://docs.asymptotelabs.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# beacon endpoint s3
> Generate AWS S3 forwarding content and validation events for Beacon endpoint events.
## Forwarding Command
Use `beacon endpoint s3` to generate AWS S3 forwarding content for Beacon endpoint events. The generated pack keeps Beacon as a local JSONL producer and helps your customer-managed Vector agent upload `runtime.jsonl` to an S3 bucket as gzip-compressed NDJSON.
Beacon does not store AWS credentials, profiles, IAM roles, bucket policies, lifecycle rules, or encryption settings in endpoint configuration. Keep those values in AWS, Vector, endpoint-management policy, or deployment tooling. For packaged macOS MDM deployments, the managed S3 helper can persist MDM-injected AWS provider-chain environment variables to the root-owned Vector environment file used by launchd.
```bash title="Command syntax" theme={null}
beacon endpoint s3 [command]
```
## Commands
Print the Vector AWS S3 forwarding template for the configured runtime log.
Write AWS S3 forwarding content to a directory.
Write and describe a Beacon AWS S3 validation event.
## Runtime log paths
| Mode | Path |
| ----------- | --------------------------------------- |
| User mode | `~/.beacon/endpoint/logs/runtime.jsonl` |
| System mode | `/var/log/beacon-agent/runtime.jsonl` |
## beacon endpoint s3 print-config
`beacon endpoint s3 print-config` prints a Vector configuration that tails the selected Beacon runtime JSONL log and writes gzip-compressed NDJSON objects to AWS S3.
```bash title="Print the configuration" theme={null}
beacon endpoint s3 print-config
```
Use this command when you want to inspect or copy the Vector template into an existing endpoint forwarding workflow.
### Examples
Print Vector config for the default per-user Beacon install:
```bash title="Print Vector config for the default per-user Beacon install" theme={null}
beacon endpoint s3 print-config
```
Print Vector config for a system-mode MDM deployment:
```bash title="Print Vector config for a system-mode MDM deployment" theme={null}
sudo /opt/beacon/bin/beacon endpoint s3 print-config --system
```
Print Vector config for a custom runtime log:
```bash title="Print Vector config for a custom runtime log" theme={null}
beacon endpoint s3 print-config --log-path /path/to/runtime.jsonl
```
### Flags
| Flag | Description |
| ------------------- | ----------------------------------------------- |
| `--user` | Use per-user endpoint paths. Enabled by default |
| `--system` | Use system endpoint paths and launch daemon |
| `--log-path ` | Runtime JSONL log path |
## beacon endpoint s3 install-pack
`beacon endpoint s3 install-pack` writes AWS S3 forwarding content to a directory.
```bash title="Generate the integration pack" theme={null}
beacon endpoint s3 install-pack --output ./beacon-s3-pack
```
The pack includes setup instructions, a one-shot AWS CLI smoke-test script, a Vector `aws_s3` forwarding template, and sample Beacon endpoint events.
The generated Vector template preserves each Beacon event's canonical
`gen_ai.usage` payload and also flattens token and runtime-reported cost fields
to top-level JSON columns for downstream analytics: `input_tokens`,
`output_tokens`, `cache_read_input_tokens`, `cache_creation_input_tokens`,
`reasoning_output_tokens`, and `cost_usd`.
### Examples
Generate a content pack for the default per-user install:
```bash title="Generate a content pack for the default per-user install" theme={null}
beacon endpoint s3 install-pack --output ./beacon-s3-pack
```
Generate a content pack for a system-mode deployment:
```bash title="Generate a content pack for a system-mode deployment" theme={null}
sudo /opt/beacon/bin/beacon endpoint s3 install-pack \
--system \
--output ./beacon-s3-pack
```
Generate a content pack for a custom runtime log:
```bash title="Generate a content pack for a custom runtime log" theme={null}
beacon endpoint s3 install-pack \
--output ./beacon-s3-pack \
--log-path /path/to/runtime.jsonl
```
### Flags
| Flag | Description |
| ------------------- | -------------------------------------------------------------------------- |
| `--output ` | Output directory for the AWS S3 content pack. Defaults to `beacon-s3-pack` |
| `--user` | Use per-user endpoint paths. Enabled by default |
| `--system` | Use system endpoint paths and launch daemon |
| `--log-path ` | Runtime JSONL log path |
## beacon endpoint s3 validate
`beacon endpoint s3 validate` writes a Beacon validation event to the runtime JSONL log and prints the expected AWS S3 validation fields and follow-up AWS CLI checks.
```bash title="Run the validation check" theme={null}
beacon endpoint s3 validate
```
### Examples
Write a validation event for the default per-user install:
```bash title="Write a validation event for the default per-user install" theme={null}
beacon endpoint s3 validate
```
Write a validation event for a system-mode deployment:
```bash title="Write a validation event for a system-mode deployment" theme={null}
sudo /opt/beacon/bin/beacon endpoint s3 validate --system
```
Write a validation event to a custom runtime log:
```bash title="Write a validation event to a custom runtime log" theme={null}
beacon endpoint s3 validate --log-path /path/to/runtime.jsonl
```
The validation command writes the local event only. Confirm remote delivery with AWS tooling:
```text theme={null}
aws s3 ls "s3://${BEACON_S3_BUCKET}/${BEACON_S3_PREFIX}/" --recursive --region "$AWS_REGION"
aws s3 cp "s3://${BEACON_S3_BUCKET}/${BEACON_S3_PREFIX}/runtime/date=/