> For the complete documentation index, see [llms.txt](https://docs.zongsoft.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.zongsoft.com/documentation/en/framework/externals/projects/amazon.md).

# Amazon (amazon)

The Amazon project's capability scope, deployment products, integration entry points, and usage boundaries.

Integrate Amazon S3 and compatible object stores through the framework file system. Suitable for applications that use Bucket and object Key to manage file resources.

| Item                  | value                                                                          |
| --------------------- | ------------------------------------------------------------------------------ |
| source code directory | `externals/amazon`                                                             |
| main bag              | `Zongsoft.Externals.Amazon`                                                    |
| Companion theme       | [Cloud Services and Callbacks](/documentation/en/framework/externals/cloud.md) |

## Deployment and Usage Portal

Append the main package to the existing host's [Deployment checklist](/documentation/en/references/deploy-files.md), and retain the plugin list, assembly and ancillary running resources in the package:

{% code title="Application.deploy (append fragment)" %}

```ini
[plugins zongsoft externals amazon]
nuget:Zongsoft.Externals.Amazon
```

{% endcode %}

The connection settings are at `/Externals/Amazon/ConnectionSettings` and the drive key is `amazon.s3`. The file system identifier is `zfs.s3`. For example, assets in `zfs.s3:/assets/manuals/start.pdf` are Buckets.

## Integration Steps

1. Prepare test buckets, connection endpoints, zones, and authorized credentials.
2. Check the existing objects according to the read-only example in the topic, and then verify that the application actually needs to enumerate, read or write.
3. Releases the stream produced by each call and confirms the write result with final object information.

For specific configuration, calling examples and related basic concepts, see [Cloud Services and Callbacks](/documentation/en/framework/externals/cloud.md).

## Project Boundaries

{% hint style="info" %}
💡 Custom endpoints use path addressing. Compatibility with S3 does not mean that all vendors behave the same; directories are just object key prefixes, and the rename, append, and random write semantics of local files should not be directly applied to object storage.
{% endhint %}

## Further Reading

[Browse extensions by project](/documentation/en/framework/externals/projects.md) · [Cloud Services and Callbacks](/documentation/en/framework/externals/cloud.md) · [source code and project description](https://github.com/Zongsoft/framework/tree/main/externals/amazon)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.zongsoft.com/documentation/en/framework/externals/projects/amazon.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.