> For the complete documentation index, see [llms.txt](https://ism-docs.xnarum.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ism-docs.xnarum.com/tasks/cloud/amazon-s3.md).

# Amazon S3

Amazon S3 or Amazon Simple Storage Service is a service offered by Amazon Web Services that provides object storage through a web service interface. Amazon S3 uses the same scalable storage infrastructure that Amazon.com uses to run its e-commerce network. (Wikipedia)

![](https://support.xnarum.com/download/manuals/ISM-Manual-2023.fld/image309.png)

The operations on this component are almost same. But the names are not same. Bucket is used for folder.

## **Input**

 

<table><thead><tr><th width="229">Attribute</th><th>Description</th></tr></thead><tbody><tr><td>Profile</td><td>IAM User to access S3</td></tr><tr><td>Amazon Region</td><td>Amazon Region of the bucket</td></tr><tr><td>Action</td><td><p>Create/Delete/List Bucket</p><p>Upload/Download/Delete File</p></td></tr><tr><td>Bucket</td><td>Bucket name</td></tr><tr><td>Key</td><td><p>Key of an object which will be uploaded or downloaded.</p><p>The contents of a file can be retrieved with key.</p></td></tr><tr><td>Media</td><td><p>Input for upload, Output for download</p><p>·       File</p><p>·       Parameter</p></td></tr><tr><td>Data</td><td>Input data when the media is parameter type.</td></tr><tr><td>Path</td><td><p>The path of the source file to be uploaded.</p><p>The path of the target file to bd downloaded.</p></td></tr></tbody></table>

The value of Profile comes from IAM.

<figure><img src="https://support.xnarum.com/download/manuals/ISM-Manual-2023.fld/image310.png" alt=""><figcaption></figcaption></figure>

## **Output**

&#x20;

<table><thead><tr><th width="206">Attribute</th><th>Description</th></tr></thead><tbody><tr><td>ResultList</td><td>Bucket list when "List Bucket" action is performed.</td></tr><tr><td>ResultContents</td><td><p>Contents of an object when "Download File" action is performed.</p><p>·        File path of downloaded object when Media is File type.</p><p>·        Stringified contents of the downloaded object when Media is Parameter type</p></td></tr></tbody></table>

&#x20;

## **Example**

### **Create a bucket**

&#x20;

<table><thead><tr><th width="216">Attribute</th><th>Description</th></tr></thead><tbody><tr><td>Profile</td><td>first</td></tr><tr><td>Amazon Region</td><td>ap-south-1</td></tr><tr><td>Action</td><td>Create a bucket</td></tr><tr><td>Bucket</td><td>my-bucket-scott</td></tr><tr><td>Key</td><td> </td></tr><tr><td>Media</td><td> </td></tr><tr><td>Data</td><td> </td></tr><tr><td>Path</td><td> </td></tr></tbody></table>

<figure><img src="https://support.xnarum.com/download/manuals/ISM-Manual-2023.fld/image311.png" alt=""><figcaption></figcaption></figure>

### **Upload a file**

&#x20;

<table><thead><tr><th width="208">Attribute</th><th>Description</th></tr></thead><tbody><tr><td>Profile</td><td>first</td></tr><tr><td>Amazon Region</td><td>ap-south-1</td></tr><tr><td>Action</td><td>Create a file</td></tr><tr><td>Bucket</td><td>my-bucket-scott</td></tr><tr><td>Key</td><td>my-key</td></tr><tr><td>Media</td><td>File</td></tr><tr><td>Data</td><td> </td></tr><tr><td>Path</td><td>/home/myuser/my-file.txt</td></tr></tbody></table>

<figure><img src="https://support.xnarum.com/download/manuals/ISM-Manual-2023.fld/image312.png" alt=""><figcaption></figcaption></figure>

### **Delete a file**

&#x20;

<table><thead><tr><th width="214">Attribute</th><th>Description</th></tr></thead><tbody><tr><td>Profile</td><td>first</td></tr><tr><td>Amazon Region</td><td>ap-south-1</td></tr><tr><td>Action</td><td>Delete a file</td></tr><tr><td>Bucket</td><td>my-bucket-scott</td></tr><tr><td>Key</td><td>my-key</td></tr><tr><td>Media</td><td> </td></tr><tr><td>Data</td><td> </td></tr><tr><td>Path</td><td> </td></tr></tbody></table>

<figure><img src="https://support.xnarum.com/download/manuals/ISM-Manual-2023.fld/image313.png" alt=""><figcaption></figcaption></figure>

### **Delete a bucket**

A bucket is not deleted if the bucket is not empty.

<table data-header-hidden><thead><tr><th width="210"></th><th></th></tr></thead><tbody><tr><td>Attributes</td><td>Description</td></tr><tr><td>Profile</td><td>first</td></tr><tr><td>Amazon Region</td><td>ap-south-1</td></tr><tr><td>Action</td><td>Delete a bucket</td></tr><tr><td>Bucket</td><td>my-bucket-scott</td></tr><tr><td>Key</td><td> </td></tr><tr><td>Media</td><td> </td></tr><tr><td>Data</td><td> </td></tr><tr><td>Path</td><td> </td></tr></tbody></table>

<figure><img src="https://support.xnarum.com/download/manuals/ISM-Manual-2023.fld/image314.png" alt=""><figcaption></figcaption></figure>


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://ism-docs.xnarum.com/tasks/cloud/amazon-s3.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.