---
sidebar_position: 14
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# List objects
 Gets the list of objects in the selected bucket



`Function ListObjects(Val Bucket, Val BasicData, Val Prefix = "", Val PageToken = "", Val Headers = Undefined) Export`

  | Parameter | CLI option | Type | Required | Description |
  |-|-|-|-|-|
  | Bucket | --bucket | String | ✔ | Bucket name |
  | BasicData | --basic | Structure of KeyAndValue | ✔ | Basic request data. See GetBasicDataStructure |
  | Prefix | --prefix | String | ✖ | Filtering by prefix, if necessary |
  | PageToken | --ctoken | String | ✖ | Page token if pagination is used |
  | Headers | --headers | Map Of KeyAndValue | ✖ | Additional request headers, if necessary |

  
  Returns:  Structure of KeyAndValue - serialized JSON response from storage

<br/>

:::tip
Method at AWS documentation: [ListObjectsV2](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html)
:::
<br/>


```bsl title="1C:Enterprise/OneScript code example"
    URL       = "storage-155.s3hoster.by";
    AccessKey = "BRN5RKJE67...";
    SecretKey = "NNhv+i9PrytpT8Tu0C1N...";
    Region    = "BTC";

    BasicData = OPI_S3.GetBasicDataStructure(URL, AccessKey, SecretKey, Region);

    Bucket = "opi-gpbucket3";
    Result = OPI_S3.ListObjects(Bucket, BasicData);
```
 

 <Tabs>
  
    <TabItem value="bash" label="Bash" default>
        ```bash
            # JSON data can also be passed as a path to a .json file
            
            oint s3 ListObjects \
             --url "storage-155.s3hoster.by" \
             --access "BRN5RKJE67YCVDZRRQVI" \
             --secret "***" \
             --region "BTC" \
             --bucket "opi-gpbucket3" \
             --basic "{'URL':'storage-155.s3hoster.by','AccessKey':'***','SecretKey':'***','Region':'BTC','Service':'s3'}"
        ```
    </TabItem>
  
    <TabItem value="bat" label="CMD/Bat" default>
        ```batch
            :: JSON data can also be passed as a path to a .json file
            
            oint s3 ListObjects ^
             --url "storage-155.s3hoster.by" ^
             --access "BRN5RKJE67YCVDZRRQVI" ^
             --secret "***" ^
             --region "BTC" ^
             --bucket "opi-gpbucket3" ^
             --basic "{'URL':'storage-155.s3hoster.by','AccessKey':'***','SecretKey':'***','Region':'BTC','Service':'s3'}"
        ```
    </TabItem>
</Tabs>


```json title="Result"
{
 "status": 200,
 "response": {
  "ListBucketResult": {
   "Name": "opi-gpbucket3",
   "Prefix": {},
   "KeyCount": "1",
   "MaxKeys": "250",
   "IsTruncated": "false",
   "Contents": {
    "Key": "picture.jpg",
    "LastModified": "2024-11-22T10:12:02.670Z",
    "ETag": "\"9e0176f87f6565a22f78e0f9b39a4d78\"",
    "Size": "2114023",
    "StorageClass": "STANDARD"
   }
  }
 },
 "headers": {
  "Accept-Ranges": "bytes",
  "Content-Length": "451",
  "Content-Type": "application/xml",
  "Date": "Fri, 22 Nov 2024 10:12:24 GMT",
  "Server": "MinIO",
  "Strict-Transport-Security": "max-age=31536000; includeSubDomains",
  "Vary": "Origin,Accept-Encoding",
  "X-Amz-Id-2": "e602da57d0c30b8c7034fcfe129917205f80f7bab979408e71da5d1441c85e79",
  "X-Amz-Request-Id": "180A42B3443D1E1D",
  "X-Content-Type-Options": "nosniff",
  "X-Xss-Protection": "1; mode=block"
 }
}
```